summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKajur, Harish (vk250x) <vk250x@att.com>2018-03-08 09:40:03 -0500
committerKajur, Harish (vk250x) <vk250x@att.com>2018-03-08 09:40:26 -0500
commit95c5189f3b8aa708feaaa78999342220321fad00 (patch)
tree11bcb21f3a427fc1a617ae2653f77466944dd370
parent55f25defdee4c12beace81f45eda5fb076d5b0e2 (diff)
Add the generated yaml and html files
Issue-ID: AAI-838 Change-Id: Iad3d92964dc333b3a2f0200b6491c7577493be87 Signed-off-by: Kajur, Harish (vk250x) <vk250x@att.com>
-rw-r--r--aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v12.html44
-rw-r--r--aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v13.html190005
-rw-r--r--aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v12.yaml51
-rw-r--r--aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v13.yaml68602
4 files changed, 258694 insertions, 8 deletions
diff --git a/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v12.html b/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v12.html
index d16b210a..d039441c 100644
--- a/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v12.html
+++ b/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v12.html
@@ -168505,7 +168505,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
</div>
<div class="panel-body">
<section class="json-schema-description">
- <p>cloud-region designates an installation of a cloud cluster or region or instantiation. In cloud, this could be an LCP or DCP. Cloud regions are uniquely identified by a composite key, cloud-owner + cloud-region-id. The format of the cloud-owner is vendor-cloudname</p>
+ <p>cloud-region designates an installation of a cloud cluster or region or instantiation.</p>
<h6 id="related-nodes">Related Nodes</h6>
<ul>
<li>TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many)</li>
@@ -168643,6 +168643,30 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
</div>
</dd>
+ <dt data-property-name="cloud-extra-info">
+ <span class="json-property-name">cloud-extra-info:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="cloud-epa-caps">
+ <span class="json-property-name">cloud-epa-caps:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>MultiVIM will discover and expose EPA capabilities.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
<dt data-property-name="resource-version">
<span class="json-property-name">resource-version:</span>
<span class="json-property-type">string</span>
@@ -169265,7 +169289,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
</div>
<div class="panel-body">
<section class="json-schema-description">
- <p>Generic configuration object.</p>
+ <p>Port Mirror Configuration.</p>
<h6 id="related-nodes">Related Nodes</h6>
<ul>
<li>TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)</li>
@@ -169378,6 +169402,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
+ <span class="json-property-required"></span>
</dt>
<dd>
<p>Orchestration status of the configuration.</p>
@@ -169390,6 +169415,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
+ <span class="json-property-required"></span>
</dt>
<dd>
<p>Indicator for whether the resource is considered operational.</p>
@@ -169402,6 +169428,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
+ <span class="json-property-required"></span>
</dt>
<dd>
<p>URL to endpoint where AAI can get more details from SDN-GC.</p>
@@ -169414,6 +169441,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
+ <span class="json-property-required"></span>
</dt>
<dd>
<p>id of the configuration used to customize the resource</p>
@@ -180929,6 +180957,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
</div>
</dd>
+ <dt data-property-name="mac-addresss">
+ <span class="json-property-name">mac-addresss:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>MAC Address of the p-interface.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
<dt data-property-name="resource-version">
<span class="json-property-name">resource-version:</span>
<span class="json-property-type">string</span>
diff --git a/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v13.html b/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v13.html
new file mode 100644
index 00000000..a9d1c9fb
--- /dev/null
+++ b/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v13.html
@@ -0,0 +1,190005 @@
+<!DOCTYPE html>
+<html>
+<head>
+<style>/*!
+ * Bootstrap v3.3.6 (http://getbootstrap.com)
+ * Copyright 2011-2015 Twitter, Inc.
+ * Licensed under MIT (https://github.com/twbs/bootstrap/blob/master/LICENSE)
+ *//*! normalize.css v3.0.3 | MIT License | github.com/necolas/normalize.css */html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}body{margin:0}article,aside,details,figcaption,figure,footer,header,hgroup,main,menu,nav,section,summary{display:block}audio,canvas,progress,video{display:inline-block;vertical-align:baseline}audio:not([controls]){display:none;height:0}[hidden],template{display:none}a{background-color:transparent}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:bold}dfn{font-style:italic}h1{font-size:2em;margin:.67em 0}mark{background:#ff0;color:#000}small{font-size:80%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-0.5em}sub{bottom:-0.25em}img{border:0}svg:not(:root){overflow:hidden}figure{margin:1em 40px}hr{box-sizing:content-box;height:0}pre{overflow:auto}code,kbd,pre,samp{font-family:monospace,monospace;font-size:1em}button,input,optgroup,select,textarea{color:inherit;font:inherit;margin:0}button{overflow:visible}button,select{text-transform:none}button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer}button[disabled],html input[disabled]{cursor:default}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}input{line-height:normal}input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0}input[type="number"]::-webkit-inner-spin-button,input[type="number"]::-webkit-outer-spin-button{height:auto}input[type="search"]{-webkit-appearance:textfield;box-sizing:content-box}input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none}fieldset{border:1px solid #c0c0c0;margin:0 2px;padding:.35em .625em .75em}legend{border:0;padding:0}textarea{overflow:auto}optgroup{font-weight:bold}table{border-collapse:collapse;border-spacing:0}td,th{padding:0}/*! Source: https://github.com/h5bp/html5-boilerplate/blob/master/src/css/main.css */@media print{*,*:before,*:after{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a,a:visited{text-decoration:underline}a[href]:after{content:" (" attr(href) ")"}abbr[title]:after{content:" (" attr(title) ")"}a[href^="#"]:after,a[href^="javascript:"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}p,h2,h3{orphans:3;widows:3}h2,h3{page-break-after:avoid}.navbar{display:none}.btn>.caret,.dropup>.btn>.caret{border-top-color:#000 !important}.label{border:1px solid #000}.table{border-collapse:collapse !important}.table td,.table th{background-color:#fff !important}.table-bordered th,.table-bordered td{border:1px solid #ddd !important}}@font-face{p EdgeRules.ftl
+ ont-family:'Glyphicons Halflings';src:url('../fonts/glyphicons-halflings-regular.eot');src:url('../fonts/glyphicons-halflings-regular.eot?#iefix') format('embedded-opentype'),url('../fonts/glyphicons-halflings-regular.woff2') format('woff2'),url('../fonts/glyphicons-halflings-regular.woff') format('woff'),url('../fonts/glyphicons-halflings-regular.ttf') format('truetype'),url('../fonts/glyphicons-halflings-regular.svg#glyphicons_halflingsregular') format('svg')}.glyphicon{position:relative;top:1px;display:inline-block;font-family:'Glyphicons Halflings';font-style:normal;font-weight:normal;line-height:1;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.glyphicon-asterisk:before{content:"\002a"}.glyphicon-plus:before{content:"\002b"}.glyphicon-euro:before,.glyphicon-eur:before{content:"\20ac"}.glyphicon-minus:before{content:"\2212"}.glyphicon-cloud:before{content:"\2601"}.glyphicon-envelope:before{content:"\2709"}.glyphicon-pencil:before{content:"\270f"}.glyphicon-glass:before{content:"\e001"}.glyphicon-music:before{content:"\e002"}.glyphicon-search:before{content:"\e003"}.glyphicon-heart:before{content:"\e005"}.glyphicon-star:before{content:"\e006"}.glyphicon-star-empty:before{content:"\e007"}.glyphicon-user:before{content:"\e008"}.glyphicon-film:before{content:"\e009"}.glyphicon-th-large:before{content:"\e010"}.glyphicon-th:before{content:"\e011"}.glyphicon-th-list:before{content:"\e012"}.glyphicon-ok:before{content:"\e013"}.glyphicon-remove:before{content:"\e014"}.glyphicon-zoom-in:before{content:"\e015"}.glyphicon-zoom-out:before{content:"\e016"}.glyphicon-off:before{content:"\e017"}.glyphicon-signal:before{content:"\e018"}.glyphicon-cog:before{content:"\e019"}.glyphicon-trash:before{content:"\e020"}.glyphicon-home:before{content:"\e021"}.glyphicon-file:before{content:"\e022"}.glyphicon-time:before{content:"\e023"}.glyphicon-road:before{content:"\e024"}.glyphicon-download-alt:before{content:"\e025"}.glyphicon-download:before{content:"\e026"}.glyphicon-upload:before{content:"\e027"}.glyphicon-inbox:before{content:"\e028"}.glyphicon-play-circle:before{content:"\e029"}.glyphicon-repeat:before{content:"\e030"}.glyphicon-refresh:before{content:"\e031"}.glyphicon-list-alt:before{content:"\e032"}.glyphicon-lock:before{content:"\e033"}.glyphicon-flag:before{content:"\e034"}.glyphicon-headphones:before{content:"\e035"}.glyphicon-volume-off:before{content:"\e036"}.glyphicon-volume-down:before{content:"\e037"}.glyphicon-volume-up:before{content:"\e038"}.glyphicon-qrcode:before{content:"\e039"}.glyphicon-barcode:before{content:"\e040"}.glyphicon-tag:before{content:"\e041"}.glyphicon-tags:before{content:"\e042"}.glyphicon-book:before{content:"\e043"}.glyphicon-bookmark:before{content:"\e044"}.glyphicon-print:before{content:"\e045"}.glyphicon-camera:before{content:"\e046"}.glyphicon-font:before{content:"\e047"}.glyphicon-bold:before{content:"\e048"}.glyphicon-italic:before{content:"\e049"}.glyphicon-text-height:before{content:"\e050"}.glyphicon-text-width:before{content:"\e051"}.glyphicon-align-left:before{content:"\e052"}.glyphicon-align-center:before{content:"\e053"}.glyphicon-align-right:before{content:"\e054"}.glyphicon-align-justify:before{content:"\e055"}.glyphicon-list:before{content:"\e056"}.glyphicon-indent-left:before{content:"\e057"}.glyphicon-indent-right:before{content:"\e058"}.glyphicon-facetime-video:before{content:"\e059"}.glyphicon-picture:before{content:"\e060"}.glyphicon-map-marker:before{content:"\e062"}.glyphicon-adjust:before{content:"\e063"}.glyphicon-tint:before{content:"\e064"}.glyphicon-edit:before{content:"\e065"}.glyphicon-share:before{content:"\e066"}.glyphicon-check:before{content:"\e067"}.glyphicon-move:before{content:"\e068"}.glyphicon-step-backward:before{content:"\e069"}.glyphicon-fast-backward:before{content:"\e070"}.glyphicon-backward:before{content:"\e071"}.glyphicon-play:before{content:"\e072"}.glyphicon-pause:before{content:"\e073"}.glyphicon-stop:before{content:"\e074"}.glyphicon-forward:before{content:"\e075"}.glyphicon-fast-forward:before{content:"\e076"}.glyphicon-step-forward:before{content:"\e077"}.glyphicon-eject:before{content:"\e078"}.glyphicon-chevron-left:before{content:"\e079"}.glyphicon-chevron-right:before{content:"\e080"}.glyphicon-plus-sign:before{content:"\e081"}.glyphicon-minus-sign:before{content:"\e082"}.glyphicon-remove-sign:before{content:"\e083"}.glyphicon-ok-sign:before{content:"\e084"}.glyphicon-question-sign:before{content:"\e085"}.glyphicon-info-sign:before{content:"\e086"}.glyphicon-screenshot:before{content:"\e087"}.glyphicon-remove-circle:before{content:"\e088"}.glyphicon-ok-circle:before{content:"\e089"}.glyphicon-ban-circle:before{content:"\e090"}.glyphicon-arrow-left:before{content:"\e091"}.glyphicon-arrow-right:before{content:"\e092"}.glyphicon-arrow-up:before{content:"\e093"}.glyphicon-arrow-down:before{content:"\e094"}.glyphicon-share-alt:before{content:"\e095"}.glyphicon-resize-full:before{content:"\e096"}.glyphicon-resize-small:before{content:"\e097"}.glyphicon-exclamation-sign:before{content:"\e101"}.glyphicon-gift:before{content:"\e102"}.glyphicon-leaf:before{content:"\e103"}.glyphicon-fire:before{content:"\e104"}.glyphicon-eye-open:before{content:"\e105"}.glyphicon-eye-close:before{content:"\e106"}.glyphicon-warning-sign:before{content:"\e107"}.glyphicon-plane:before{content:"\e108"}.glyphicon-calendar:before{content:"\e109"}.glyphicon-random:before{content:"\e110"}.glyphicon-comment:before{content:"\e111"}.glyphicon-magnet:before{content:"\e112"}.glyphicon-chevron-up:before{content:"\e113"}.glyphicon-chevron-down:before{content:"\e114"}.glyphicon-retweet:before{content:"\e115"}.glyphicon-shopping-cart:before{content:"\e116"}.glyphicon-folder-close:before{content:"\e117"}.glyphicon-folder-open:before{content:"\e118"}.glyphicon-resize-vertical:before{content:"\e119"}.glyphicon-resize-horizontal:before{content:"\e120"}.glyphicon-hdd:before{content:"\e121"}.glyphicon-bullhorn:before{content:"\e122"}.glyphicon-bell:before{content:"\e123"}.glyphicon-certificate:before{content:"\e124"}.glyphicon-thumbs-up:before{content:"\e125"}.glyphicon-thumbs-down:before{content:"\e126"}.glyphicon-hand-right:before{content:"\e127"}.glyphicon-hand-left:before{content:"\e128"}.glyphicon-hand-up:before{content:"\e129"}.glyphicon-hand-down:before{content:"\e130"}.glyphicon-circle-arrow-right:before{content:"\e131"}.glyphicon-circle-arrow-left:before{content:"\e132"}.glyphicon-circle-arrow-up:before{content:"\e133"}.glyphicon-circle-arrow-down:before{content:"\e134"}.glyphicon-globe:before{content:"\e135"}.glyphicon-wrench:before{content:"\e136"}.glyphicon-tasks:before{content:"\e137"}.glyphicon-filter:before{content:"\e138"}.glyphicon-briefcase:before{content:"\e139"}.glyphicon-fullscreen:before{content:"\e140"}.glyphicon-dashboard:before{content:"\e141"}.glyphicon-paperclip:before{content:"\e142"}.glyphicon-heart-empty:before{content:"\e143"}.glyphicon-link:before{content:"\e144"}.glyphicon-phone:before{content:"\e145"}.glyphicon-pushpin:before{content:"\e146"}.glyphicon-usd:before{content:"\e148"}.glyphicon-gbp:before{content:"\e149"}.glyphicon-sort:before{content:"\e150"}.glyphicon-sort-by-alphabet:before{content:"\e151"}.glyphicon-sort-by-alphabet-alt:before{content:"\e152"}.glyphicon-sort-by-order:before{content:"\e153"}.glyphicon-sort-by-order-alt:before{content:"\e154"}.glyphicon-sort-by-attributes:before{content:"\e155"}.glyphicon-sort-by-attributes-alt:before{content:"\e156"}.glyphicon-unchecked:before{content:"\e157"}.glyphicon-expand:before{content:"\e158"}.glyphicon-collapse-down:before{content:"\e159"}.glyphicon-collapse-up:before{content:"\e160"}.glyphicon-log-in:before{content:"\e161"}.glyphicon-flash:before{content:"\e162"}.glyphicon-log-out:before{content:"\e163"}.glyphicon-new-window:before{content:"\e164"}.glyphicon-record:before{content:"\e165"}.glyphicon-save:before{content:"\e166"}.glyphicon-open:before{content:"\e167"}.glyphicon-saved:before{content:"\e168"}.glyphicon-import:before{content:"\e169"}.glyphicon-export:before{content:"\e170"}.glyphicon-send:before{content:"\e171"}.glyphicon-floppy-disk:before{content:"\e172"}.glyphicon-floppy-saved:before{content:"\e173"}.glyphicon-floppy-remove:before{content:"\e174"}.glyphicon-floppy-save:before{content:"\e175"}.glyphicon-floppy-open:before{content:"\e176"}.glyphicon-credit-card:before{content:"\e177"}.glyphicon-transfer:before{content:"\e178"}.glyphicon-cutlery:before{content:"\e179"}.glyphicon-header:before{content:"\e180"}.glyphicon-compressed:before{content:"\e181"}.glyphicon-earphone:before{content:"\e182"}.glyphicon-phone-alt:before{content:"\e183"}.glyphicon-tower:before{content:"\e184"}.glyphicon-stats:before{content:"\e185"}.glyphicon-sd-video:before{content:"\e186"}.glyphicon-hd-video:before{content:"\e187"}.glyphicon-subtitles:before{content:"\e188"}.glyphicon-sound-stereo:before{content:"\e189"}.glyphicon-sound-dolby:before{content:"\e190"}.glyphicon-sound-5-1:before{content:"\e191"}.glyphicon-sound-6-1:before{content:"\e192"}.glyphicon-sound-7-1:before{content:"\e193"}.glyphicon-copyright-mark:before{content:"\e194"}.glyphicon-registration-mark:before{content:"\e195"}.glyphicon-cloud-download:before{content:"\e197"}.glyphicon-cloud-upload:before{content:"\e198"}.glyphicon-tree-conifer:before{content:"\e199"}.glyphicon-tree-deciduous:before{content:"\e200"}.glyphicon-cd:before{content:"\e201"}.glyphicon-save-file:before{content:"\e202"}.glyphicon-open-file:before{content:"\e203"}.glyphicon-level-up:before{content:"\e204"}.glyphicon-copy:before{content:"\e205"}.glyphicon-paste:before{content:"\e206"}.glyphicon-alert:before{content:"\e209"}.glyphicon-equalizer:before{content:"\e210"}.glyphicon-king:before{content:"\e211"}.glyphicon-queen:before{content:"\e212"}.glyphicon-pawn:before{content:"\e213"}.glyphicon-bishop:before{content:"\e214"}.glyphicon-knight:before{content:"\e215"}.glyphicon-baby-formula:before{content:"\e216"}.glyphicon-tent:before{content:"\26fa"}.glyphicon-blackboard:before{content:"\e218"}.glyphicon-bed:before{content:"\e219"}.glyphicon-apple:before{content:"\f8ff"}.glyphicon-erase:before{content:"\e221"}.glyphicon-hourglass:before{content:"\231b"}.glyphicon-lamp:before{content:"\e223"}.glyphicon-duplicate:before{content:"\e224"}.glyphicon-piggy-bank:before{content:"\e225"}.glyphicon-scissors:before{content:"\e226"}.glyphicon-bitcoin:before{content:"\e227"}.glyphicon-btc:before{content:"\e227"}.glyphicon-xbt:before{content:"\e227"}.glyphicon-yen:before{content:"\00a5"}.glyphicon-jpy:before{content:"\00a5"}.glyphicon-ruble:before{content:"\20bd"}.glyphicon-rub:before{content:"\20bd"}.glyphicon-scale:before{content:"\e230"}.glyphicon-ice-lolly:before{content:"\e231"}.glyphicon-ice-lolly-tasted:before{content:"\e232"}.glyphicon-education:before{content:"\e233"}.glyphicon-option-horizontal:before{content:"\e234"}.glyphicon-option-vertical:before{content:"\e235"}.glyphicon-menu-hamburger:before{content:"\e236"}.glyphicon-modal-window:before{content:"\e237"}.glyphicon-oil:before{content:"\e238"}.glyphicon-grain:before{content:"\e239"}.glyphicon-sunglasses:before{content:"\e240"}.glyphicon-text-size:before{content:"\e241"}.glyphicon-text-color:before{content:"\e242"}.glyphicon-text-background:before{content:"\e243"}.glyphicon-object-align-top:before{content:"\e244"}.glyphicon-object-align-bottom:before{content:"\e245"}.glyphicon-object-align-horizontal:before{content:"\e246"}.glyphicon-object-align-left:before{content:"\e247"}.glyphicon-object-align-vertical:before{content:"\e248"}.glyphicon-object-align-right:before{content:"\e249"}.glyphicon-triangle-right:before{content:"\e250"}.glyphicon-triangle-left:before{content:"\e251"}.glyphicon-triangle-bottom:before{content:"\e252"}.glyphicon-triangle-top:before{content:"\e253"}.glyphicon-console:before{content:"\e254"}.glyphicon-superscript:before{content:"\e255"}.glyphicon-subscript:before{content:"\e256"}.glyphicon-menu-left:before{content:"\e257"}.glyphicon-menu-right:before{content:"\e258"}.glyphicon-menu-down:before{content:"\e259"}.glyphicon-menu-up:before{content:"\e260"}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}*:before,*:after{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:10px;-webkit-tap-highlight-color:rgba(0,0,0,0)}body{font-family:"Helvetica Neue",Helvetica,Arial,sans-serif;font-size:14px;line-height:1.42857143;color:#333;background-color:#fff}input,button,select,textarea{font-family:inherit;font-size:inherit;line-height:inherit}a{color:#337ab7;text-decoration:none}a:hover,a:focus{color:#23527c;text-decoration:underline}a:focus{outline:thin dotted;outline:5px auto -webkit-focus-ring-color;outline-offset:-2px}figure{margin:0}img{vertical-align:middle}.img-responsive,.thumbnail>img,.thumbnail a>img,.carousel-inner>.item>img,.carousel-inner>.item>a>img{display:block;max-width:100%;height:auto}.img-rounded{border-radius:6px}.img-thumbnail{padding:4px;line-height:1.42857143;background-color:#fff;border:1px solid #ddd;border-radius:4px;-webkit-transition:all .2s ease-in-out;-o-transition:all .2s ease-in-out;transition:all .2s ease-in-out;display:inline-block;max-width:100%;height:auto}.img-circle{border-radius:50%}hr{margin-top:20px;margin-bottom:20px;border:0;border-top:1px solid #eee}.sr-only{position:absolute;width:1px;height:1px;margin:-1px;padding:0;overflow:hidden;clip:rect(0, 0, 0, 0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}[role="button"]{cursor:pointer}h1,h2,h3,h4,h5,h6,.h1,.h2,.h3,.h4,.h5,.h6{font-family:inherit;font-weight:500;line-height:1.1;color:inherit}h1 small,h2 small,h3 small,h4 small,h5 small,h6 small,.h1 small,.h2 small,.h3 small,.h4 small,.h5 small,.h6 small,h1 .small,h2 .small,h3 .small,h4 .small,h5 .small,h6 .small,.h1 .small,.h2 .small,.h3 .small,.h4 .small,.h5 .small,.h6 .small{font-weight:normal;line-height:1;color:#777}h1,.h1,h2,.h2,h3,.h3{margin-top:20px;margin-bottom:10px}h1 small,.h1 small,h2 small,.h2 small,h3 small,.h3 small,h1 .small,.h1 .small,h2 .small,.h2 .small,h3 .small,.h3 .small{font-size:65%}h4,.h4,h5,.h5,h6,.h6{margin-top:10px;margin-bottom:10px}h4 small,.h4 small,h5 small,.h5 small,h6 small,.h6 small,h4 .small,.h4 .small,h5 .small,.h5 .small,h6 .small,.h6 .small{font-size:75%}h1,.h1{font-size:36px}h2,.h2{font-size:30px}h3,.h3{font-size:24px}h4,.h4{font-size:18px}h5,.h5{font-size:14px}h6,.h6{font-size:12px}p{margin:0 0 10px}.lead{margin-bottom:20px;font-size:16px;font-weight:300;line-height:1.4}@media (min-width:768px){.lead{font-size:21px}}small,.small{font-size:85%}mark,.mark{background-color:#fcf8e3;padding:.2em}.text-left{text-align:left}.text-right{text-align:right}.text-center{text-align:center}.text-justify{text-align:justify}.text-nowrap{white-space:nowrap}.text-lowercase{text-transform:lowercase}.text-uppercase{text-transform:uppercase}.text-capitalize{text-transform:capitalize}.text-muted{color:#777}.text-primary{color:#337ab7}a.text-primary:hover,a.text-primary:focus{color:#286090}.text-success{color:#3c763d}a.text-success:hover,a.text-success:focus{color:#2b542c}.text-info{color:#31708f}a.text-info:hover,a.text-info:focus{color:#245269}.text-warning{color:#8a6d3b}a.text-warning:hover,a.text-warning:focus{color:#66512c}.text-danger{color:#a94442}a.text-danger:hover,a.text-danger:focus{color:#843534}.bg-primary{color:#fff;background-color:#337ab7}a.bg-primary:hover,a.bg-primary:focus{background-color:#286090}.bg-success{background-color:#dff0d8}a.bg-success:hover,a.bg-success:focus{background-color:#c1e2b3}.bg-info{background-color:#d9edf7}a.bg-info:hover,a.bg-info:focus{background-color:#afd9ee}.bg-warning{background-color:#fcf8e3}a.bg-warning:hover,a.bg-warning:focus{background-color:#f7ecb5}.bg-danger{background-color:#f2dede}a.bg-danger:hover,a.bg-danger:focus{background-color:#e4b9b9}.page-header{padding-bottom:9px;margin:40px 0 20px;border-bottom:1px solid #eee}ul,ol{margin-top:0;margin-bottom:10px}ul ul,ol ul,ul ol,ol ol{margin-bottom:0}.list-unstyled{padding-left:0;list-style:none}.list-inline{padding-left:0;list-style:none;margin-left:-5px}.list-inline>li{display:inline-block;padding-left:5px;padding-right:5px}dl{margin-top:0;margin-bottom:20px}dt,dd{line-height:1.42857143}dt{font-weight:bold}dd{margin-left:0}@media (min-width:768px){.dl-horizontal dt{float:left;width:160px;clear:left;text-align:right;overflow:hidden;text-overflow:ellipsis;white-space:nowrap}.dl-horizontal dd{margin-left:180px}}abbr[title],abbr[data-original-title]{cursor:help;border-bottom:1px dotted #777}.initialism{font-size:90%;text-transform:uppercase}blockquote{padding:10px 20px;margin:0 0 20px;font-size:17.5px;border-left:5px solid #eee}blockquote p:last-child,blockquote ul:last-child,blockquote ol:last-child{margin-bottom:0}blockquote footer,blockquote small,blockquote .small{display:block;font-size:80%;line-height:1.42857143;color:#777}blockquote footer:before,blockquote small:before,blockquote .small:before{content:'\2014 \00A0'}.blockquote-reverse,blockquote.pull-right{padding-right:15px;padding-left:0;border-right:5px solid #eee;border-left:0;text-align:right}.blockquote-reverse footer:before,blockquote.pull-right footer:before,.blockquote-reverse small:before,blockquote.pull-right small:before,.blockquote-reverse .small:before,blockquote.pull-right .small:before{content:''}.blockquote-reverse footer:after,blockquote.pull-right footer:after,.blockquote-reverse small:after,blockquote.pull-right small:after,.blockquote-reverse .small:after,blockquote.pull-right .small:after{content:'\00A0 \2014'}address{margin-bottom:20px;font-style:normal;line-height:1.42857143}code,kbd,pre,samp{font-family:Menlo,Monaco,Consolas,"Courier New",monospace}code{padding:2px 4px;font-size:90%;color:#c7254e;background-color:#f9f2f4;border-radius:4px}kbd{padding:2px 4px;font-size:90%;color:#fff;background-color:#333;border-radius:3px;box-shadow:inset 0 -1px 0 rgba(0,0,0,0.25)}kbd kbd{padding:0;font-size:100%;font-weight:bold;box-shadow:none}pre{display:block;padding:9.5px;margin:0 0 10px;font-size:13px;line-height:1.42857143;word-break:break-all;word-wrap:break-word;color:#333;background-color:#f5f5f5;border:1px solid #ccc;border-radius:4px}pre code{padding:0;font-size:inherit;color:inherit;white-space:pre-wrap;background-color:transparent;border-radius:0}.pre-scrollable{max-height:340px;overflow-y:scroll}.container{margin-right:auto;margin-left:auto;padding-left:15px;padding-right:15px}@media (min-width:768px){.container{width:800px}}@media (min-width:992px){.container{width:970px}}@media (min-width:1200px){.container{width:900px}}.container-fluid{margin-right:auto;margin-left:auto;padding-left:15px;padding-right:15px}.row{margin-left:-15px;margin-right:-15px}.col-xs-1, .col-sm-1, .col-md-1, .col-lg-1, .col-xs-2, .col-sm-2, .col-md-2, .col-lg-2, .col-xs-3, .col-sm-3, .col-md-3, .col-lg-3, .col-xs-4, .col-sm-4, .col-md-4, .col-lg-4, .col-xs-5, .col-sm-5, .col-md-5, .col-lg-5, .col-xs-6, .col-sm-6, .col-md-6, .col-lg-6, .col-xs-7, .col-sm-7, .col-md-7, .col-lg-7, .col-xs-8, .col-sm-8, .col-md-8, .col-lg-8, .col-xs-9, .col-sm-9, .col-md-9, .col-lg-9, .col-xs-10, .col-sm-10, .col-md-10, .col-lg-10, .col-xs-11, .col-sm-11, .col-md-11, .col-lg-11, .col-xs-12, .col-sm-12, .col-md-12, .col-lg-12{position:relative;min-height:1px;padding-left:15px;padding-right:15px}.col-xs-1, .col-xs-2, .col-xs-3, .col-xs-4, .col-xs-5, .col-xs-6, .col-xs-7, .col-xs-8, .col-xs-9, .col-xs-10, .col-xs-11, .col-xs-12{float:left}.col-xs-12{width:100%}.col-xs-11{width:91.66666667%}.col-xs-10{width:83.33333333%}.col-xs-9{width:75%}.col-xs-8{width:66.66666667%}.col-xs-7{width:58.33333333%}.col-xs-6{width:50%}.col-xs-5{width:41.66666667%}.col-xs-4{width:33.33333333%}.col-xs-3{width:25%}.col-xs-2{width:16.66666667%}.col-xs-1{width:8.33333333%}.col-xs-pull-12{right:100%}.col-xs-pull-11{right:91.66666667%}.col-xs-pull-10{right:83.33333333%}.col-xs-pull-9{right:75%}.col-xs-pull-8{right:66.66666667%}.col-xs-pull-7{right:58.33333333%}.col-xs-pull-6{right:50%}.col-xs-pull-5{right:41.66666667%}.col-xs-pull-4{right:33.33333333%}.col-xs-pull-3{right:25%}.col-xs-pull-2{right:16.66666667%}.col-xs-pull-1{right:8.33333333%}.col-xs-pull-0{right:auto}.col-xs-push-12{left:100%}.col-xs-push-11{left:91.66666667%}.col-xs-push-10{left:83.33333333%}.col-xs-push-9{left:75%}.col-xs-push-8{left:66.66666667%}.col-xs-push-7{left:58.33333333%}.col-xs-push-6{left:50%}.col-xs-push-5{left:41.66666667%}.col-xs-push-4{left:33.33333333%}.col-xs-push-3{left:25%}.col-xs-push-2{left:16.66666667%}.col-xs-push-1{left:8.33333333%}.col-xs-push-0{left:auto}.col-xs-offset-12{margin-left:100%}.col-xs-offset-11{margin-left:91.66666667%}.col-xs-offset-10{margin-left:83.33333333%}.col-xs-offset-9{margin-left:75%}.col-xs-offset-8{margin-left:66.66666667%}.col-xs-offset-7{margin-left:58.33333333%}.col-xs-offset-6{margin-left:50%}.col-xs-offset-5{margin-left:41.66666667%}.col-xs-offset-4{margin-left:33.33333333%}.col-xs-offset-3{margin-left:25%}.col-xs-offset-2{margin-left:16.66666667%}.col-xs-offset-1{margin-left:8.33333333%}.col-xs-offset-0{margin-left:0}@media (min-width:768px){.col-sm-1, .col-sm-2, .col-sm-3, .col-sm-4, .col-sm-5, .col-sm-6, .col-sm-7, .col-sm-8, .col-sm-9, .col-sm-10, .col-sm-11, .col-sm-12{float:left}.col-sm-12{width:100%}.col-sm-11{width:91.66666667%}.col-sm-10{width:83.33333333%}.col-sm-9{width:75%}.col-sm-8{width:66.66666667%}.col-sm-7{width:58.33333333%}.col-sm-6{width:50%}.col-sm-5{width:41.66666667%}.col-sm-4{width:33.33333333%}.col-sm-3{width:25%}.col-sm-2{width:16.66666667%}.col-sm-1{width:8.33333333%}.col-sm-pull-12{right:100%}.col-sm-pull-11{right:91.66666667%}.col-sm-pull-10{right:83.33333333%}.col-sm-pull-9{right:75%}.col-sm-pull-8{right:66.66666667%}.col-sm-pull-7{right:58.33333333%}.col-sm-pull-6{right:50%}.col-sm-pull-5{right:41.66666667%}.col-sm-pull-4{right:33.33333333%}.col-sm-pull-3{right:25%}.col-sm-pull-2{right:16.66666667%}.col-sm-pull-1{right:8.33333333%}.col-sm-pull-0{right:auto}.col-sm-push-12{left:100%}.col-sm-push-11{left:91.66666667%}.col-sm-push-10{left:83.33333333%}.col-sm-push-9{left:75%}.col-sm-push-8{left:66.66666667%}.col-sm-push-7{left:58.33333333%}.col-sm-push-6{left:50%}.col-sm-push-5{left:41.66666667%}.col-sm-push-4{left:33.33333333%}.col-sm-push-3{left:25%}.col-sm-push-2{left:16.66666667%}.col-sm-push-1{left:8.33333333%}.col-sm-push-0{left:auto}.col-sm-offset-12{margin-left:100%}.col-sm-offset-11{margin-left:91.66666667%}.col-sm-offset-10{margin-left:83.33333333%}.col-sm-offset-9{margin-left:75%}.col-sm-offset-8{margin-left:66.66666667%}.col-sm-offset-7{margin-left:58.33333333%}.col-sm-offset-6{margin-left:50%}.col-sm-offset-5{margin-left:41.66666667%}.col-sm-offset-4{margin-left:33.33333333%}.col-sm-offset-3{margin-left:25%}.col-sm-offset-2{margin-left:16.66666667%}.col-sm-offset-1{margin-left:8.33333333%}.col-sm-offset-0{margin-left:0}}@media (min-width:992px){.col-md-1, .col-md-2, .col-md-3, .col-md-4, .col-md-5, .col-md-6, .col-md-7, .col-md-8, .col-md-9, .col-md-10, .col-md-11, .col-md-12{float:left}.col-md-12{width:100%}.col-md-11{width:91.66666667%}.col-md-10{width:83.33333333%}.col-md-9{width:75%}.col-md-8{width:66.66666667%}.col-md-7{width:58.33333333%}.col-md-6{width:50%}.col-md-5{width:41.66666667%}.col-md-4{width:33.33333333%}.col-md-3{width:25%}.col-md-2{width:16.66666667%}.col-md-1{width:8.33333333%}.col-md-pull-12{right:100%}.col-md-pull-11{right:91.66666667%}.col-md-pull-10{right:83.33333333%}.col-md-pull-9{right:75%}.col-md-pull-8{right:66.66666667%}.col-md-pull-7{right:58.33333333%}.col-md-pull-6{right:50%}.col-md-pull-5{right:41.66666667%}.col-md-pull-4{right:33.33333333%}.col-md-pull-3{right:25%}.col-md-pull-2{right:16.66666667%}.col-md-pull-1{right:8.33333333%}.col-md-pull-0{right:auto}.col-md-push-12{left:100%}.col-md-push-11{left:91.66666667%}.col-md-push-10{left:83.33333333%}.col-md-push-9{left:75%}.col-md-push-8{left:66.66666667%}.col-md-push-7{left:58.33333333%}.col-md-push-6{left:50%}.col-md-push-5{left:41.66666667%}.col-md-push-4{left:33.33333333%}.col-md-push-3{left:25%}.col-md-push-2{left:16.66666667%}.col-md-push-1{left:8.33333333%}.col-md-push-0{left:auto}.col-md-offset-12{margin-left:100%}.col-md-offset-11{margin-left:91.66666667%}.col-md-offset-10{margin-left:83.33333333%}.col-md-offset-9{margin-left:75%}.col-md-offset-8{margin-left:66.66666667%}.col-md-offset-7{margin-left:58.33333333%}.col-md-offset-6{margin-left:50%}.col-md-offset-5{margin-left:41.66666667%}.col-md-offset-4{margin-left:33.33333333%}.col-md-offset-3{margin-left:25%}.col-md-offset-2{margin-left:16.66666667%}.col-md-offset-1{margin-left:8.33333333%}.col-md-offset-0{margin-left:0}}@media (min-width:1200px){.col-lg-1, .col-lg-2, .col-lg-3, .col-lg-4, .col-lg-5, .col-lg-6, .col-lg-7, .col-lg-8, .col-lg-9, .col-lg-10, .col-lg-11, .col-lg-12{float:left}.col-lg-12{width:100%}.col-lg-11{width:91.66666667%}.col-lg-10{width:83.33333333%}.col-lg-9{width:75%}.col-lg-8{width:66.66666667%}.col-lg-7{width:58.33333333%}.col-lg-6{width:50%}.col-lg-5{width:41.66666667%}.col-lg-4{width:33.33333333%}.col-lg-3{width:25%}.col-lg-2{width:16.66666667%}.col-lg-1{width:8.33333333%}.col-lg-pull-12{right:100%}.col-lg-pull-11{right:91.66666667%}.col-lg-pull-10{right:83.33333333%}.col-lg-pull-9{right:75%}.col-lg-pull-8{right:66.66666667%}.col-lg-pull-7{right:58.33333333%}.col-lg-pull-6{right:50%}.col-lg-pull-5{right:41.66666667%}.col-lg-pull-4{right:33.33333333%}.col-lg-pull-3{right:25%}.col-lg-pull-2{right:16.66666667%}.col-lg-pull-1{right:8.33333333%}.col-lg-pull-0{right:auto}.col-lg-push-12{left:100%}.col-lg-push-11{left:91.66666667%}.col-lg-push-10{left:83.33333333%}.col-lg-push-9{left:75%}.col-lg-push-8{left:66.66666667%}.col-lg-push-7{left:58.33333333%}.col-lg-push-6{left:50%}.col-lg-push-5{left:41.66666667%}.col-lg-push-4{left:33.33333333%}.col-lg-push-3{left:25%}.col-lg-push-2{left:16.66666667%}.col-lg-push-1{left:8.33333333%}.col-lg-push-0{left:auto}.col-lg-offset-12{margin-left:100%}.col-lg-offset-11{margin-left:91.66666667%}.col-lg-offset-10{margin-left:83.33333333%}.col-lg-offset-9{margin-left:75%}.col-lg-offset-8{margin-left:66.66666667%}.col-lg-offset-7{margin-left:58.33333333%}.col-lg-offset-6{margin-left:50%}.col-lg-offset-5{margin-left:41.66666667%}.col-lg-offset-4{margin-left:33.33333333%}.col-lg-offset-3{margin-left:25%}.col-lg-offset-2{margin-left:16.66666667%}.col-lg-offset-1{margin-left:8.33333333%}.col-lg-offset-0{margin-left:0}}table{background-color:transparent}caption{padding-top:8px;padding-bottom:8px;color:#777;text-align:left}th{text-align:left}.table{width:100%;max-width:100%;margin-bottom:20px}.table>thead>tr>th,.table>tbody>tr>th,.table>tfoot>tr>th,.table>thead>tr>td,.table>tbody>tr>td,.table>tfoot>tr>td{padding:8px;line-height:1.42857143;vertical-align:top;border-top:1px solid #ddd}.table>thead>tr>th{vertical-align:bottom;border-bottom:2px solid #ddd}.table>caption+thead>tr:first-child>th,.table>colgroup+thead>tr:first-child>th,.table>thead:first-child>tr:first-child>th,.table>caption+thead>tr:first-child>td,.table>colgroup+thead>tr:first-child>td,.table>thead:first-child>tr:first-child>td{border-top:0}.table>tbody+tbody{border-top:2px solid #ddd}.table .table{background-color:#fff}.table-condensed>thead>tr>th,.table-condensed>tbody>tr>th,.table-condensed>tfoot>tr>th,.table-condensed>thead>tr>td,.table-condensed>tbody>tr>td,.table-condensed>tfoot>tr>td{padding:5px}.table-bordered{border:1px solid #ddd}.table-bordered>thead>tr>th,.table-bordered>tbody>tr>th,.table-bordered>tfoot>tr>th,.table-bordered>thead>tr>td,.table-bordered>tbody>tr>td,.table-bordered>tfoot>tr>td{border:1px solid #ddd}.table-bordered>thead>tr>th,.table-bordered>thead>tr>td{border-bottom-width:2px}.table-striped>tbody>tr:nth-of-type(odd){background-color:#f9f9f9}.table-hover>tbody>tr:hover{background-color:#f5f5f5}table col[class*="col-"]{position:static;float:none;display:table-column}table td[class*="col-"],table th[class*="col-"]{position:static;float:none;display:table-cell}.table>thead>tr>td.active,.table>tbody>tr>td.active,.table>tfoot>tr>td.active,.table>thead>tr>th.active,.table>tbody>tr>th.active,.table>tfoot>tr>th.active,.table>thead>tr.active>td,.table>tbody>tr.active>td,.table>tfoot>tr.active>td,.table>thead>tr.active>th,.table>tbody>tr.active>th,.table>tfoot>tr.active>th{background-color:#f5f5f5}.table-hover>tbody>tr>td.active:hover,.table-hover>tbody>tr>th.active:hover,.table-hover>tbody>tr.active:hover>td,.table-hover>tbody>tr:hover>.active,.table-hover>tbody>tr.active:hover>th{background-color:#e8e8e8}.table>thead>tr>td.success,.table>tbody>tr>td.success,.table>tfoot>tr>td.success,.table>thead>tr>th.success,.table>tbody>tr>th.success,.table>tfoot>tr>th.success,.table>thead>tr.success>td,.table>tbody>tr.success>td,.table>tfoot>tr.success>td,.table>thead>tr.success>th,.table>tbody>tr.success>th,.table>tfoot>tr.success>th{background-color:#dff0d8}.table-hover>tbody>tr>td.success:hover,.table-hover>tbody>tr>th.success:hover,.table-hover>tbody>tr.success:hover>td,.table-hover>tbody>tr:hover>.success,.table-hover>tbody>tr.success:hover>th{background-color:#d0e9c6}.table>thead>tr>td.info,.table>tbody>tr>td.info,.table>tfoot>tr>td.info,.table>thead>tr>th.info,.table>tbody>tr>th.info,.table>tfoot>tr>th.info,.table>thead>tr.info>td,.table>tbody>tr.info>td,.table>tfoot>tr.info>td,.table>thead>tr.info>th,.table>tbody>tr.info>th,.table>tfoot>tr.info>th{background-color:#d9edf7}.table-hover>tbody>tr>td.info:hover,.table-hover>tbody>tr>th.info:hover,.table-hover>tbody>tr.info:hover>td,.table-hover>tbody>tr:hover>.info,.table-hover>tbody>tr.info:hover>th{background-color:#c4e3f3}.table>thead>tr>td.warning,.table>tbody>tr>td.warning,.table>tfoot>tr>td.warning,.table>thead>tr>th.warning,.table>tbody>tr>th.warning,.table>tfoot>tr>th.warning,.table>thead>tr.warning>td,.table>tbody>tr.warning>td,.table>tfoot>tr.warning>td,.table>thead>tr.warning>th,.table>tbody>tr.warning>th,.table>tfoot>tr.warning>th{background-color:#fcf8e3}.table-hover>tbody>tr>td.warning:hover,.table-hover>tbody>tr>th.warning:hover,.table-hover>tbody>tr.warning:hover>td,.table-hover>tbody>tr:hover>.warning,.table-hover>tbody>tr.warning:hover>th{background-color:#faf2cc}.table>thead>tr>td.danger,.table>tbody>tr>td.danger,.table>tfoot>tr>td.danger,.table>thead>tr>th.danger,.table>tbody>tr>th.danger,.table>tfoot>tr>th.danger,.table>thead>tr.danger>td,.table>tbody>tr.danger>td,.table>tfoot>tr.danger>td,.table>thead>tr.danger>th,.table>tbody>tr.danger>th,.table>tfoot>tr.danger>th{background-color:#f2dede}.table-hover>tbody>tr>td.danger:hover,.table-hover>tbody>tr>th.danger:hover,.table-hover>tbody>tr.danger:hover>td,.table-hover>tbody>tr:hover>.danger,.table-hover>tbody>tr.danger:hover>th{background-color:#ebcccc}.table-responsive{overflow-x:auto;min-height:.01%}@media screen and (max-width:767px){.table-responsive{width:100%;margin-bottom:15px;overflow-y:hidden;-ms-overflow-style:-ms-autohiding-scrollbar;border:1px solid #ddd}.table-responsive>.table{margin-bottom:0}.table-responsive>.table>thead>tr>th,.table-responsive>.table>tbody>tr>th,.table-responsive>.table>tfoot>tr>th,.table-responsive>.table>thead>tr>td,.table-responsive>.table>tbody>tr>td,.table-responsive>.table>tfoot>tr>td{white-space:nowrap}.table-responsive>.table-bordered{border:0}.table-responsive>.table-bordered>thead>tr>th:first-child,.table-responsive>.table-bordered>tbody>tr>th:first-child,.table-responsive>.table-bordered>tfoot>tr>th:first-child,.table-responsive>.table-bordered>thead>tr>td:first-child,.table-responsive>.table-bordered>tbody>tr>td:first-child,.table-responsive>.table-bordered>tfoot>tr>td:first-child{border-left:0}.table-responsive>.table-bordered>thead>tr>th:last-child,.table-responsive>.table-bordered>tbody>tr>th:last-child,.table-responsive>.table-bordered>tfoot>tr>th:last-child,.table-responsive>.table-bordered>thead>tr>td:last-child,.table-responsive>.table-bordered>tbody>tr>td:last-child,.table-responsive>.table-bordered>tfoot>tr>td:last-child{border-right:0}.table-responsive>.table-bordered>tbody>tr:last-child>th,.table-responsive>.table-bordered>tfoot>tr:last-child>th,.table-responsive>.table-bordered>tbody>tr:last-child>td,.table-responsive>.table-bordered>tfoot>tr:last-child>td{border-bottom:0}}fieldset{padding:0;margin:0;border:0;min-width:0}legend{display:block;width:100%;padding:0;margin-bottom:20px;font-size:21px;line-height:inherit;color:#333;border:0;border-bottom:1px solid #e5e5e5}label{display:inline-block;max-width:100%;margin-bottom:5px;font-weight:bold}input[type="search"]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type="radio"],input[type="checkbox"]{margin:4px 0 0;margin-top:1px \9;line-height:normal}input[type="file"]{display:block}input[type="range"]{display:block;width:100%}select[multiple],select[size]{height:auto}input[type="file"]:focus,input[type="radio"]:focus,input[type="checkbox"]:focus{outline:thin dotted;outline:5px auto -webkit-focus-ring-color;outline-offset:-2px}output{display:block;padding-top:7px;font-size:14px;line-height:1.42857143;color:#555}.form-control{display:block;width:100%;height:34px;padding:6px 12px;font-size:14px;line-height:1.42857143;color:#555;background-color:#fff;background-image:none;border:1px solid #ccc;border-radius:4px;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075);box-shadow:inset 0 1px 1px rgba(0,0,0,0.075);-webkit-transition:border-color ease-in-out .15s, box-shadow ease-in-out .15s;-o-transition:border-color ease-in-out .15s, box-shadow ease-in-out .15s;transition:border-color ease-in-out .15s, box-shadow ease-in-out .15s}.form-control:focus{border-color:#66afe9;outline:0;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,.075), 0 0 8px rgba(102, 175, 233, 0.6);box-shadow:inset 0 1px 1px rgba(0,0,0,.075), 0 0 8px rgba(102, 175, 233, 0.6)}.form-control::-moz-placeholder{color:#999;opacity:1}.form-control:-ms-input-placeholder{color:#999}.form-control::-webkit-input-placeholder{color:#999}.form-control::-ms-expand{border:0;background-color:transparent}.form-control[disabled],.form-control[readonly],fieldset[disabled] .form-control{background-color:#eee;opacity:1}.form-control[disabled],fieldset[disabled] .form-control{cursor:not-allowed}textarea.form-control{height:auto}input[type="search"]{-webkit-appearance:none}@media screen and (-webkit-min-device-pixel-ratio:0){input[type="date"].form-control,input[type="time"].form-control,input[type="datetime-local"].form-control,input[type="month"].form-control{line-height:34px}input[type="date"].input-sm,input[type="time"].input-sm,input[type="datetime-local"].input-sm,input[type="month"].input-sm,.input-group-sm input[type="date"],.input-group-sm input[type="time"],.input-group-sm input[type="datetime-local"],.input-group-sm input[type="month"]{line-height:30px}input[type="date"].input-lg,input[type="time"].input-lg,input[type="datetime-local"].input-lg,input[type="month"].input-lg,.input-group-lg input[type="date"],.input-group-lg input[type="time"],.input-group-lg input[type="datetime-local"],.input-group-lg input[type="month"]{line-height:46px}}.form-group{margin-bottom:15px}.radio,.checkbox{position:relative;display:block;margin-top:10px;margin-bottom:10px}.radio label,.checkbox label{min-height:20px;padding-left:20px;margin-bottom:0;font-weight:normal;cursor:pointer}.radio input[type="radio"],.radio-inline input[type="radio"],.checkbox input[type="checkbox"],.checkbox-inline input[type="checkbox"]{position:absolute;margin-left:-20px;margin-top:4px \9}.radio+.radio,.checkbox+.checkbox{margin-top:-5px}.radio-inline,.checkbox-inline{position:relative;display:inline-block;padding-left:20px;margin-bottom:0;vertical-align:middle;font-weight:normal;cursor:pointer}.radio-inline+.radio-inline,.checkbox-inline+.checkbox-inline{margin-top:0;margin-left:10px}input[type="radio"][disabled],input[type="checkbox"][disabled],input[type="radio"].disabled,input[type="checkbox"].disabled,fieldset[disabled] input[type="radio"],fieldset[disabled] input[type="checkbox"]{cursor:not-allowed}.radio-inline.disabled,.checkbox-inline.disabled,fieldset[disabled] .radio-inline,fieldset[disabled] .checkbox-inline{cursor:not-allowed}.radio.disabled label,.checkbox.disabled label,fieldset[disabled] .radio label,fieldset[disabled] .checkbox label{cursor:not-allowed}.form-control-static{padding-top:7px;padding-bottom:7px;margin-bottom:0;min-height:34px}.form-control-static.input-lg,.form-control-static.input-sm{padding-left:0;padding-right:0}.input-sm{height:30px;padding:5px 10px;font-size:12px;line-height:1.5;border-radius:3px}select.input-sm{height:30px;line-height:30px}textarea.input-sm,select[multiple].input-sm{height:auto}.form-group-sm .form-control{height:30px;padding:5px 10px;font-size:12px;line-height:1.5;border-radius:3px}.form-group-sm select.form-control{height:30px;line-height:30px}.form-group-sm textarea.form-control,.form-group-sm select[multiple].form-control{height:auto}.form-group-sm .form-control-static{height:30px;min-height:32px;padding:6px 10px;font-size:12px;line-height:1.5}.input-lg{height:46px;padding:10px 16px;font-size:18px;line-height:1.3333333;border-radius:6px}select.input-lg{height:46px;line-height:46px}textarea.input-lg,select[multiple].input-lg{height:auto}.form-group-lg .form-control{height:46px;padding:10px 16px;font-size:18px;line-height:1.3333333;border-radius:6px}.form-group-lg select.form-control{height:46px;line-height:46px}.form-group-lg textarea.form-control,.form-group-lg select[multiple].form-control{height:auto}.form-group-lg .form-control-static{height:46px;min-height:38px;padding:11px 16px;font-size:18px;line-height:1.3333333}.has-feedback{position:relative}.has-feedback .form-control{padding-right:42.5px}.form-control-feedback{position:absolute;top:0;right:0;z-index:2;display:block;width:34px;height:34px;line-height:34px;text-align:center;pointer-events:none}.input-lg+.form-control-feedback,.input-group-lg+.form-control-feedback,.form-group-lg .form-control+.form-control-feedback{width:46px;height:46px;line-height:46px}.input-sm+.form-control-feedback,.input-group-sm+.form-control-feedback,.form-group-sm .form-control+.form-control-feedback{width:30px;height:30px;line-height:30px}.has-success .help-block,.has-success .control-label,.has-success .radio,.has-success .checkbox,.has-success .radio-inline,.has-success .checkbox-inline,.has-success.radio label,.has-success.checkbox label,.has-success.radio-inline label,.has-success.checkbox-inline label{color:#3c763d}.has-success .form-control{border-color:#3c763d;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075);box-shadow:inset 0 1px 1px rgba(0,0,0,0.075)}.has-success .form-control:focus{border-color:#2b542c;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075),0 0 6px #67b168;box-shadow:inset 0 1px 1px rgba(0,0,0,0.075),0 0 6px #67b168}.has-success .input-group-addon{color:#3c763d;border-color:#3c763d;background-color:#dff0d8}.has-success .form-control-feedback{color:#3c763d}.has-warning .help-block,.has-warning .control-label,.has-warning .radio,.has-warning .checkbox,.has-warning .radio-inline,.has-warning .checkbox-inline,.has-warning.radio label,.has-warning.checkbox label,.has-warning.radio-inline label,.has-warning.checkbox-inline label{color:#8a6d3b}.has-warning .form-control{border-color:#8a6d3b;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075);box-shadow:inset 0 1px 1px rgba(0,0,0,0.075)}.has-warning .form-control:focus{border-color:#66512c;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075),0 0 6px #c0a16b;box-shadow:inset 0 1px 1px rgba(0,0,0,0.075),0 0 6px #c0a16b}.has-warning .input-group-addon{color:#8a6d3b;border-color:#8a6d3b;background-color:#fcf8e3}.has-warning .form-control-feedback{color:#8a6d3b}.has-error .help-block,.has-error .control-label,.has-error .radio,.has-error .checkbox,.has-error .radio-inline,.has-error .checkbox-inline,.has-error.radio label,.has-error.checkbox label,.has-error.radio-inline label,.has-error.checkbox-inline label{color:#a94442}.has-error .form-control{border-color:#a94442;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075);box-shadow:inset 0 1px 1px rgba(0,0,0,0.075)}.has-error .form-control:focus{border-color:#843534;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075),0 0 6px #ce8483;box-shadow:inset 0 1px 1px rgba(0,0,0,0.075),0 0 6px #ce8483}.has-error .input-group-addon{color:#a94442;border-color:#a94442;background-color:#f2dede}.has-error .form-control-feedback{color:#a94442}.has-feedback label~.form-control-feedback{top:25px}.has-feedback label.sr-only~.form-control-feedback{top:0}.help-block{display:block;margin-top:5px;margin-bottom:10px;color:#737373}@media (min-width:768px){.form-inline .form-group{display:inline-block;margin-bottom:0;vertical-align:middle}.form-inline .form-control{display:inline-block;width:auto;vertical-align:middle}.form-inline .form-control-static{display:inline-block}.form-inline .input-group{display:inline-table;vertical-align:middle}.form-inline .input-group .input-group-addon,.form-inline .input-group .input-group-btn,.form-inline .input-group .form-control{width:auto}.form-inline .input-group>.form-control{width:100%}.form-inline .control-label{margin-bottom:0;vertical-align:middle}.form-inline .radio,.form-inline .checkbox{display:inline-block;margin-top:0;margin-bottom:0;vertical-align:middle}.form-inline .radio label,.form-inline .checkbox label{padding-left:0}.form-inline .radio input[type="radio"],.form-inline .checkbox input[type="checkbox"]{position:relative;margin-left:0}.form-inline .has-feedback .form-control-feedback{top:0}}.form-horizontal .radio,.form-horizontal .checkbox,.form-horizontal .radio-inline,.form-horizontal .checkbox-inline{margin-top:0;margin-bottom:0;padding-top:7px}.form-horizontal .radio,.form-horizontal .checkbox{min-height:27px}.form-horizontal .form-group{margin-left:-15px;margin-right:-15px}@media (min-width:768px){.form-horizontal .control-label{text-align:right;margin-bottom:0;padding-top:7px}}.form-horizontal .has-feedback .form-control-feedback{right:15px}@media (min-width:768px){.form-horizontal .form-group-lg .control-label{padding-top:11px;font-size:18px}}@media (min-width:768px){.form-horizontal .form-group-sm .control-label{padding-top:6px;font-size:12px}}.btn{display:inline-block;margin-bottom:0;font-weight:normal;text-align:center;vertical-align:middle;touch-action:manipulation;cursor:pointer;background-image:none;border:1px solid transparent;white-space:nowrap;padding:6px 12px;font-size:14px;line-height:1.42857143;border-radius:4px;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}.btn:focus,.btn:active:focus,.btn.active:focus,.btn.focus,.btn:active.focus,.btn.active.focus{outline:thin dotted;outline:5px auto -webkit-focus-ring-color;outline-offset:-2px}.btn:hover,.btn:focus,.btn.focus{color:#333;text-decoration:none}.btn:active,.btn.active{outline:0;background-image:none;-webkit-box-shadow:inset 0 3px 5px rgba(0,0,0,0.125);box-shadow:inset 0 3px 5px rgba(0,0,0,0.125)}.btn.disabled,.btn[disabled],fieldset[disabled] .btn{cursor:not-allowed;opacity:.65;filter:alpha(opacity=65);-webkit-box-shadow:none;box-shadow:none}a.btn.disabled,fieldset[disabled] a.btn{pointer-events:none}.btn-default{color:#333;background-color:#fff;border-color:#ccc}.btn-default:focus,.btn-default.focus{color:#333;background-color:#e6e6e6;border-color:#8c8c8c}.btn-default:hover{color:#333;background-color:#e6e6e6;border-color:#adadad}.btn-default:active,.btn-default.active,.open>.dropdown-toggle.btn-default{color:#333;background-color:#e6e6e6;border-color:#adadad}.btn-default:active:hover,.btn-default.active:hover,.open>.dropdown-toggle.btn-default:hover,.btn-default:active:focus,.btn-default.active:focus,.open>.dropdown-toggle.btn-default:focus,.btn-default:active.focus,.btn-default.active.focus,.open>.dropdown-toggle.btn-default.focus{color:#333;background-color:#d4d4d4;border-color:#8c8c8c}.btn-default:active,.btn-default.active,.open>.dropdown-toggle.btn-default{background-image:none}.btn-default.disabled:hover,.btn-default[disabled]:hover,fieldset[disabled] .btn-default:hover,.btn-default.disabled:focus,.btn-default[disabled]:focus,fieldset[disabled] .btn-default:focus,.btn-default.disabled.focus,.btn-default[disabled].focus,fieldset[disabled] .btn-default.focus{background-color:#fff;border-color:#ccc}.btn-default .badge{color:#fff;background-color:#333}.btn-primary{color:#fff;background-color:#337ab7;border-color:#2e6da4}.btn-primary:focus,.btn-primary.focus{color:#fff;background-color:#286090;border-color:#122b40}.btn-primary:hover{color:#fff;background-color:#286090;border-color:#204d74}.btn-primary:active,.btn-primary.active,.open>.dropdown-toggle.btn-primary{color:#fff;background-color:#286090;border-color:#204d74}.btn-primary:active:hover,.btn-primary.active:hover,.open>.dropdown-toggle.btn-primary:hover,.btn-primary:active:focus,.btn-primary.active:focus,.open>.dropdown-toggle.btn-primary:focus,.btn-primary:active.focus,.btn-primary.active.focus,.open>.dropdown-toggle.btn-primary.focus{color:#fff;background-color:#204d74;border-color:#122b40}.btn-primary:active,.btn-primary.active,.open>.dropdown-toggle.btn-primary{background-image:none}.btn-primary.disabled:hover,.btn-primary[disabled]:hover,fieldset[disabled] .btn-primary:hover,.btn-primary.disabled:focus,.btn-primary[disabled]:focus,fieldset[disabled] .btn-primary:focus,.btn-primary.disabled.focus,.btn-primary[disabled].focus,fieldset[disabled] .btn-primary.focus{background-color:#337ab7;border-color:#2e6da4}.btn-primary .badge{color:#337ab7;background-color:#fff}.btn-success{color:#fff;background-color:#5cb85c;border-color:#4cae4c}.btn-success:focus,.btn-success.focus{color:#fff;background-color:#449d44;border-color:#255625}.btn-success:hover{color:#fff;background-color:#449d44;border-color:#398439}.btn-success:active,.btn-success.active,.open>.dropdown-toggle.btn-success{color:#fff;background-color:#449d44;border-color:#398439}.btn-success:active:hover,.btn-success.active:hover,.open>.dropdown-toggle.btn-success:hover,.btn-success:active:focus,.btn-success.active:focus,.open>.dropdown-toggle.btn-success:focus,.btn-success:active.focus,.btn-success.active.focus,.open>.dropdown-toggle.btn-success.focus{color:#fff;background-color:#398439;border-color:#255625}.btn-success:active,.btn-success.active,.open>.dropdown-toggle.btn-success{background-image:none}.btn-success.disabled:hover,.btn-success[disabled]:hover,fieldset[disabled] .btn-success:hover,.btn-success.disabled:focus,.btn-success[disabled]:focus,fieldset[disabled] .btn-success:focus,.btn-success.disabled.focus,.btn-success[disabled].focus,fieldset[disabled] .btn-success.focus{background-color:#5cb85c;border-color:#4cae4c}.btn-success .badge{color:#5cb85c;background-color:#fff}.btn-info{color:#fff;background-color:#5bc0de;border-color:#46b8da}.btn-info:focus,.btn-info.focus{color:#fff;background-color:#31b0d5;border-color:#1b6d85}.btn-info:hover{color:#fff;background-color:#31b0d5;border-color:#269abc}.btn-info:active,.btn-info.active,.open>.dropdown-toggle.btn-info{color:#fff;background-color:#31b0d5;border-color:#269abc}.btn-info:active:hover,.btn-info.active:hover,.open>.dropdown-toggle.btn-info:hover,.btn-info:active:focus,.btn-info.active:focus,.open>.dropdown-toggle.btn-info:focus,.btn-info:active.focus,.btn-info.active.focus,.open>.dropdown-toggle.btn-info.focus{color:#fff;background-color:#269abc;border-color:#1b6d85}.btn-info:active,.btn-info.active,.open>.dropdown-toggle.btn-info{background-image:none}.btn-info.disabled:hover,.btn-info[disabled]:hover,fieldset[disabled] .btn-info:hover,.btn-info.disabled:focus,.btn-info[disabled]:focus,fieldset[disabled] .btn-info:focus,.btn-info.disabled.focus,.btn-info[disabled].focus,fieldset[disabled] .btn-info.focus{background-color:#5bc0de;border-color:#46b8da}.btn-info .badge{color:#5bc0de;background-color:#fff}.btn-warning{color:#fff;background-color:#f0ad4e;border-color:#eea236}.btn-warning:focus,.btn-warning.focus{color:#fff;background-color:#ec971f;border-color:#985f0d}.btn-warning:hover{color:#fff;background-color:#ec971f;border-color:#d58512}.btn-warning:active,.btn-warning.active,.open>.dropdown-toggle.btn-warning{color:#fff;background-color:#ec971f;border-color:#d58512}.btn-warning:active:hover,.btn-warning.active:hover,.open>.dropdown-toggle.btn-warning:hover,.btn-warning:active:focus,.btn-warning.active:focus,.open>.dropdown-toggle.btn-warning:focus,.btn-warning:active.focus,.btn-warning.active.focus,.open>.dropdown-toggle.btn-warning.focus{color:#fff;background-color:#d58512;border-color:#985f0d}.btn-warning:active,.btn-warning.active,.open>.dropdown-toggle.btn-warning{background-image:none}.btn-warning.disabled:hover,.btn-warning[disabled]:hover,fieldset[disabled] .btn-warning:hover,.btn-warning.disabled:focus,.btn-warning[disabled]:focus,fieldset[disabled] .btn-warning:focus,.btn-warning.disabled.focus,.btn-warning[disabled].focus,fieldset[disabled] .btn-warning.focus{background-color:#f0ad4e;border-color:#eea236}.btn-warning .badge{color:#f0ad4e;background-color:#fff}.btn-danger{color:#fff;background-color:#d9534f;border-color:#d43f3a}.btn-danger:focus,.btn-danger.focus{color:#fff;background-color:#c9302c;border-color:#761c19}.btn-danger:hover{color:#fff;background-color:#c9302c;border-color:#ac2925}.btn-danger:active,.btn-danger.active,.open>.dropdown-toggle.btn-danger{color:#fff;background-color:#c9302c;border-color:#ac2925}.btn-danger:active:hover,.btn-danger.active:hover,.open>.dropdown-toggle.btn-danger:hover,.btn-danger:active:focus,.btn-danger.active:focus,.open>.dropdown-toggle.btn-danger:focus,.btn-danger:active.focus,.btn-danger.active.focus,.open>.dropdown-toggle.btn-danger.focus{color:#fff;background-color:#ac2925;border-color:#761c19}.btn-danger:active,.btn-danger.active,.open>.dropdown-toggle.btn-danger{background-image:none}.btn-danger.disabled:hover,.btn-danger[disabled]:hover,fieldset[disabled] .btn-danger:hover,.btn-danger.disabled:focus,.btn-danger[disabled]:focus,fieldset[disabled] .btn-danger:focus,.btn-danger.disabled.focus,.btn-danger[disabled].focus,fieldset[disabled] .btn-danger.focus{background-color:#d9534f;border-color:#d43f3a}.btn-danger .badge{color:#d9534f;background-color:#fff}.btn-link{color:#337ab7;font-weight:normal;border-radius:0}.btn-link,.btn-link:active,.btn-link.active,.btn-link[disabled],fieldset[disabled] .btn-link{background-color:transparent;-webkit-box-shadow:none;box-shadow:none}.btn-link,.btn-link:hover,.btn-link:focus,.btn-link:active{border-color:transparent}.btn-link:hover,.btn-link:focus{color:#23527c;text-decoration:underline;background-color:transparent}.btn-link[disabled]:hover,fieldset[disabled] .btn-link:hover,.btn-link[disabled]:focus,fieldset[disabled] .btn-link:focus{color:#777;text-decoration:none}.btn-lg,.btn-group-lg>.btn{padding:10px 16px;font-size:18px;line-height:1.3333333;border-radius:6px}.btn-sm,.btn-group-sm>.btn{padding:5px 10px;font-size:12px;line-height:1.5;border-radius:3px}.btn-xs,.btn-group-xs>.btn{padding:1px 5px;font-size:12px;line-height:1.5;border-radius:3px}.btn-block{display:block;width:100%}.btn-block+.btn-block{margin-top:5px}input[type="submit"].btn-block,input[type="reset"].btn-block,input[type="button"].btn-block{width:100%}.fade{opacity:0;-webkit-transition:opacity .15s linear;-o-transition:opacity .15s linear;transition:opacity .15s linear}.fade.in{opacity:1}.collapse{display:none}.collapse.in{display:block}tr.collapse.in{display:table-row}tbody.collapse.in{display:table-row-group}.collapsing{position:relative;height:0;overflow:hidden;-webkit-transition-property:height, visibility;transition-property:height, visibility;-webkit-transition-duration:.35s;transition-duration:.35s;-webkit-transition-timing-function:ease;transition-timing-function:ease}.caret{display:inline-block;width:0;height:0;margin-left:2px;vertical-align:middle;border-top:4px dashed;border-top:4px solid \9;border-right:4px solid transparent;border-left:4px solid transparent}.dropup,.dropdown{position:relative}.dropdown-toggle:focus{outline:0}.dropdown-menu{position:absolute;top:100%;left:0;z-index:1000;display:none;float:left;min-width:160px;padding:5px 0;margin:2px 0 0;list-style:none;font-size:14px;text-align:left;background-color:#fff;border:1px solid #ccc;border:1px solid rgba(0,0,0,0.15);border-radius:4px;-webkit-box-shadow:0 6px 12px rgba(0,0,0,0.175);box-shadow:0 6px 12px rgba(0,0,0,0.175);background-clip:padding-box}.dropdown-menu.pull-right{right:0;left:auto}.dropdown-menu .divider{height:1px;margin:9px 0;overflow:hidden;background-color:#e5e5e5}.dropdown-menu>li>a{display:block;padding:3px 20px;clear:both;font-weight:normal;line-height:1.42857143;color:#333;white-space:nowrap}.dropdown-menu>li>a:hover,.dropdown-menu>li>a:focus{text-decoration:none;color:#262626;background-color:#f5f5f5}.dropdown-menu>.active>a,.dropdown-menu>.active>a:hover,.dropdown-menu>.active>a:focus{color:#fff;text-decoration:none;outline:0;background-color:#337ab7}.dropdown-menu>.disabled>a,.dropdown-menu>.disabled>a:hover,.dropdown-menu>.disabled>a:focus{color:#777}.dropdown-menu>.disabled>a:hover,.dropdown-menu>.disabled>a:focus{text-decoration:none;background-color:transparent;background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);cursor:not-allowed}.open>.dropdown-menu{display:block}.open>a{outline:0}.dropdown-menu-right{left:auto;right:0}.dropdown-menu-left{left:0;right:auto}.dropdown-header{display:block;padding:3px 20px;font-size:12px;line-height:1.42857143;color:#777;white-space:nowrap}.dropdown-backdrop{position:fixed;left:0;right:0;bottom:0;top:0;z-index:990}.pull-right>.dropdown-menu{right:0;left:auto}.dropup .caret,.navbar-fixed-bottom .dropdown .caret{border-top:0;border-bottom:4px dashed;border-bottom:4px solid \9;content:""}.dropup .dropdown-menu,.navbar-fixed-bottom .dropdown .dropdown-menu{top:auto;bottom:100%;margin-bottom:2px}@media (min-width:768px){.navbar-right .dropdown-menu{left:auto;right:0}.navbar-right .dropdown-menu-left{left:0;right:auto}}.btn-group,.btn-group-vertical{position:relative;display:inline-block;vertical-align:middle}.btn-group>.btn,.btn-group-vertical>.btn{position:relative;float:left}.btn-group>.btn:hover,.btn-group-vertical>.btn:hover,.btn-group>.btn:focus,.btn-group-vertical>.btn:focus,.btn-group>.btn:active,.btn-group-vertical>.btn:active,.btn-group>.btn.active,.btn-group-vertical>.btn.active{z-index:2}.btn-group .btn+.btn,.btn-group .btn+.btn-group,.btn-group .btn-group+.btn,.btn-group .btn-group+.btn-group{margin-left:-1px}.btn-toolbar{margin-left:-5px}.btn-toolbar .btn,.btn-toolbar .btn-group,.btn-toolbar .input-group{float:left}.btn-toolbar>.btn,.btn-toolbar>.btn-group,.btn-toolbar>.input-group{margin-left:5px}.btn-group>.btn:not(:first-child):not(:last-child):not(.dropdown-toggle){border-radius:0}.btn-group>.btn:first-child{margin-left:0}.btn-group>.btn:first-child:not(:last-child):not(.dropdown-toggle){border-bottom-right-radius:0;border-top-right-radius:0}.btn-group>.btn:last-child:not(:first-child),.btn-group>.dropdown-toggle:not(:first-child){border-bottom-left-radius:0;border-top-left-radius:0}.btn-group>.btn-group{float:left}.btn-group>.btn-group:not(:first-child):not(:last-child)>.btn{border-radius:0}.btn-group>.btn-group:first-child:not(:last-child)>.btn:last-child,.btn-group>.btn-group:first-child:not(:last-child)>.dropdown-toggle{border-bottom-right-radius:0;border-top-right-radius:0}.btn-group>.btn-group:last-child:not(:first-child)>.btn:first-child{border-bottom-left-radius:0;border-top-left-radius:0}.btn-group .dropdown-toggle:active,.btn-group.open .dropdown-toggle{outline:0}.btn-group>.btn+.dropdown-toggle{padding-left:8px;padding-right:8px}.btn-group>.btn-lg+.dropdown-toggle{padding-left:12px;padding-right:12px}.btn-group.open .dropdown-toggle{-webkit-box-shadow:inset 0 3px 5px rgba(0,0,0,0.125);box-shadow:inset 0 3px 5px rgba(0,0,0,0.125)}.btn-group.open .dropdown-toggle.btn-link{-webkit-box-shadow:none;box-shadow:none}.btn .caret{margin-left:0}.btn-lg .caret{border-width:5px 5px 0;border-bottom-width:0}.dropup .btn-lg .caret{border-width:0 5px 5px}.btn-group-vertical>.btn,.btn-group-vertical>.btn-group,.btn-group-vertical>.btn-group>.btn{display:block;float:none;width:100%;max-width:100%}.btn-group-vertical>.btn-group>.btn{float:none}.btn-group-vertical>.btn+.btn,.btn-group-vertical>.btn+.btn-group,.btn-group-vertical>.btn-group+.btn,.btn-group-vertical>.btn-group+.btn-group{margin-top:-1px;margin-left:0}.btn-group-vertical>.btn:not(:first-child):not(:last-child){border-radius:0}.btn-group-vertical>.btn:first-child:not(:last-child){border-top-right-radius:4px;border-top-left-radius:4px;border-bottom-right-radius:0;border-bottom-left-radius:0}.btn-group-vertical>.btn:last-child:not(:first-child){border-top-right-radius:0;border-top-left-radius:0;border-bottom-right-radius:4px;border-bottom-left-radius:4px}.btn-group-vertical>.btn-group:not(:first-child):not(:last-child)>.btn{border-radius:0}.btn-group-vertical>.btn-group:first-child:not(:last-child)>.btn:last-child,.btn-group-vertical>.btn-group:first-child:not(:last-child)>.dropdown-toggle{border-bottom-right-radius:0;border-bottom-left-radius:0}.btn-group-vertical>.btn-group:last-child:not(:first-child)>.btn:first-child{border-top-right-radius:0;border-top-left-radius:0}.btn-group-justified{display:table;width:100%;table-layout:fixed;border-collapse:separate}.btn-group-justified>.btn,.btn-group-justified>.btn-group{float:none;display:table-cell;width:1%}.btn-group-justified>.btn-group .btn{width:100%}.btn-group-justified>.btn-group .dropdown-menu{left:auto}[data-toggle="buttons"]>.btn input[type="radio"],[data-toggle="buttons"]>.btn-group>.btn input[type="radio"],[data-toggle="buttons"]>.btn input[type="checkbox"],[data-toggle="buttons"]>.btn-group>.btn input[type="checkbox"]{position:absolute;clip:rect(0, 0, 0, 0);pointer-events:none}.input-group{position:relative;display:table;border-collapse:separate}.input-group[class*="col-"]{float:none;padding-left:0;padding-right:0}.input-group .form-control{position:relative;z-index:2;float:left;width:100%;margin-bottom:0}.input-group .form-control:focus{z-index:3}.input-group-lg>.form-control,.input-group-lg>.input-group-addon,.input-group-lg>.input-group-btn>.btn{height:46px;padding:10px 16px;font-size:18px;line-height:1.3333333;border-radius:6px}select.input-group-lg>.form-control,select.input-group-lg>.input-group-addon,select.input-group-lg>.input-group-btn>.btn{height:46px;line-height:46px}textarea.input-group-lg>.form-control,textarea.input-group-lg>.input-group-addon,textarea.input-group-lg>.input-group-btn>.btn,select[multiple].input-group-lg>.form-control,select[multiple].input-group-lg>.input-group-addon,select[multiple].input-group-lg>.input-group-btn>.btn{height:auto}.input-group-sm>.form-control,.input-group-sm>.input-group-addon,.input-group-sm>.input-group-btn>.btn{height:30px;padding:5px 10px;font-size:12px;line-height:1.5;border-radius:3px}select.input-group-sm>.form-control,select.input-group-sm>.input-group-addon,select.input-group-sm>.input-group-btn>.btn{height:30px;line-height:30px}textarea.input-group-sm>.form-control,textarea.input-group-sm>.input-group-addon,textarea.input-group-sm>.input-group-btn>.btn,select[multiple].input-group-sm>.form-control,select[multiple].input-group-sm>.input-group-addon,select[multiple].input-group-sm>.input-group-btn>.btn{height:auto}.input-group-addon,.input-group-btn,.input-group .form-control{display:table-cell}.input-group-addon:not(:first-child):not(:last-child),.input-group-btn:not(:first-child):not(:last-child),.input-group .form-control:not(:first-child):not(:last-child){border-radius:0}.input-group-addon,.input-group-btn{width:1%;white-space:nowrap;vertical-align:middle}.input-group-addon{padding:6px 12px;font-size:14px;font-weight:normal;line-height:1;color:#555;text-align:center;background-color:#eee;border:1px solid #ccc;border-radius:4px}.input-group-addon.input-sm{padding:5px 10px;font-size:12px;border-radius:3px}.input-group-addon.input-lg{padding:10px 16px;font-size:18px;border-radius:6px}.input-group-addon input[type="radio"],.input-group-addon input[type="checkbox"]{margin-top:0}.input-group .form-control:first-child,.input-group-addon:first-child,.input-group-btn:first-child>.btn,.input-group-btn:first-child>.btn-group>.btn,.input-group-btn:first-child>.dropdown-toggle,.input-group-btn:last-child>.btn:not(:last-child):not(.dropdown-toggle),.input-group-btn:last-child>.btn-group:not(:last-child)>.btn{border-bottom-right-radius:0;border-top-right-radius:0}.input-group-addon:first-child{border-right:0}.input-group .form-control:last-child,.input-group-addon:last-child,.input-group-btn:last-child>.btn,.input-group-btn:last-child>.btn-group>.btn,.input-group-btn:last-child>.dropdown-toggle,.input-group-btn:first-child>.btn:not(:first-child),.input-group-btn:first-child>.btn-group:not(:first-child)>.btn{border-bottom-left-radius:0;border-top-left-radius:0}.input-group-addon:last-child{border-left:0}.input-group-btn{position:relative;font-size:0;white-space:nowrap}.input-group-btn>.btn{position:relative}.input-group-btn>.btn+.btn{margin-left:-1px}.input-group-btn>.btn:hover,.input-group-btn>.btn:focus,.input-group-btn>.btn:active{z-index:2}.input-group-btn:first-child>.btn,.input-group-btn:first-child>.btn-group{margin-right:-1px}.input-group-btn:last-child>.btn,.input-group-btn:last-child>.btn-group{z-index:2;margin-left:-1px}.nav{margin-bottom:0;padding-left:0;list-style:none}.nav>li{position:relative;display:block}.nav>li>a{position:relative;display:block;padding:10px 15px}.nav>li>a:hover,.nav>li>a:focus{text-decoration:none;background-color:#eee}.nav>li.disabled>a{color:#777}.nav>li.disabled>a:hover,.nav>li.disabled>a:focus{color:#777;text-decoration:none;background-color:transparent;cursor:not-allowed}.nav .open>a,.nav .open>a:hover,.nav .open>a:focus{background-color:#eee;border-color:#337ab7}.nav .nav-divider{height:1px;margin:9px 0;overflow:hidden;background-color:#e5e5e5}.nav>li>a>img{max-width:none}.nav-tabs{border-bottom:1px solid #ddd}.nav-tabs>li{float:left;margin-bottom:-1px}.nav-tabs>li>a{margin-right:2px;line-height:1.42857143;border:1px solid transparent;border-radius:4px 4px 0 0}.nav-tabs>li>a:hover{border-color:#eee #eee #ddd}.nav-tabs>li.active>a,.nav-tabs>li.active>a:hover,.nav-tabs>li.active>a:focus{color:#555;background-color:#fff;border:1px solid #ddd;border-bottom-color:transparent;cursor:default}.nav-tabs.nav-justified{width:100%;border-bottom:0}.nav-tabs.nav-justified>li{float:none}.nav-tabs.nav-justified>li>a{text-align:center;margin-bottom:5px}.nav-tabs.nav-justified>.dropdown .dropdown-menu{top:auto;left:auto}@media (min-width:768px){.nav-tabs.nav-justified>li{display:table-cell;width:1%}.nav-tabs.nav-justified>li>a{margin-bottom:0}}.nav-tabs.nav-justified>li>a{margin-right:0;border-radius:4px}.nav-tabs.nav-justified>.active>a,.nav-tabs.nav-justified>.active>a:hover,.nav-tabs.nav-justified>.active>a:focus{border:1px solid #ddd}@media (min-width:768px){.nav-tabs.nav-justified>li>a{border-bottom:1px solid #ddd;border-radius:4px 4px 0 0}.nav-tabs.nav-justified>.active>a,.nav-tabs.nav-justified>.active>a:hover,.nav-tabs.nav-justified>.active>a:focus{border-bottom-color:#fff}}.nav-pills>li{float:left}.nav-pills>li>a{border-radius:4px}.nav-pills>li+li{margin-left:2px}.nav-pills>li.active>a,.nav-pills>li.active>a:hover,.nav-pills>li.active>a:focus{color:#fff;background-color:#337ab7}.nav-stacked>li{float:none}.nav-stacked>li+li{margin-top:2px;margin-left:0}.nav-justified{width:100%}.nav-justified>li{float:none}.nav-justified>li>a{text-align:center;margin-bottom:5px}.nav-justified>.dropdown .dropdown-menu{top:auto;left:auto}@media (min-width:768px){.nav-justified>li{display:table-cell;width:1%}.nav-justified>li>a{margin-bottom:0}}.nav-tabs-justified{border-bottom:0}.nav-tabs-justified>li>a{margin-right:0;border-radius:4px}.nav-tabs-justified>.active>a,.nav-tabs-justified>.active>a:hover,.nav-tabs-justified>.active>a:focus{border:1px solid #ddd}@media (min-width:768px){.nav-tabs-justified>li>a{border-bottom:1px solid #ddd;border-radius:4px 4px 0 0}.nav-tabs-justified>.active>a,.nav-tabs-justified>.active>a:hover,.nav-tabs-justified>.active>a:focus{border-bottom-color:#fff}}.tab-content>.tab-pane{display:none}.tab-content>.active{display:block}.nav-tabs .dropdown-menu{margin-top:-1px;border-top-right-radius:0;border-top-left-radius:0}.navbar{position:relative;min-height:50px;margin-bottom:20px;border:1px solid transparent}@media (min-width:768px){.navbar{border-radius:4px}}@media (min-width:768px){.navbar-header{float:left}}.navbar-collapse{overflow-x:visible;padding-right:15px;padding-left:15px;border-top:1px solid transparent;box-shadow:inset 0 1px 0 rgba(255,255,255,0.1);-webkit-overflow-scrolling:touch}.navbar-collapse.in{overflow-y:auto}@media (min-width:768px){.navbar-collapse{width:auto;border-top:0;box-shadow:none}.navbar-collapse.collapse{display:block !important;height:auto !important;padding-bottom:0;overflow:visible !important}.navbar-collapse.in{overflow-y:visible}.navbar-fixed-top .navbar-collapse,.navbar-static-top .navbar-collapse,.navbar-fixed-bottom .navbar-collapse{padding-left:0;padding-right:0}}.navbar-fixed-top .navbar-collapse,.navbar-fixed-bottom .navbar-collapse{max-height:340px}@media (max-device-width:480px) and (orientation:landscape){.navbar-fixed-top .navbar-collapse,.navbar-fixed-bottom .navbar-collapse{max-height:200px}}.container>.navbar-header,.container-fluid>.navbar-header,.container>.navbar-collapse,.container-fluid>.navbar-collapse{margin-right:-15px;margin-left:-15px}@media (min-width:768px){.container>.navbar-header,.container-fluid>.navbar-header,.container>.navbar-collapse,.container-fluid>.navbar-collapse{margin-right:0;margin-left:0}}.navbar-static-top{z-index:1000;border-width:0 0 1px}@media (min-width:768px){.navbar-static-top{border-radius:0}}.navbar-fixed-top,.navbar-fixed-bottom{position:fixed;right:0;left:0;z-index:1030}@media (min-width:768px){.navbar-fixed-top,.navbar-fixed-bottom{border-radius:0}}.navbar-fixed-top{top:0;border-width:0 0 1px}.navbar-fixed-bottom{bottom:0;margin-bottom:0;border-width:1px 0 0}.navbar-brand{float:left;padding:15px 15px;font-size:18px;line-height:20px;height:50px}.navbar-brand:hover,.navbar-brand:focus{text-decoration:none}.navbar-brand>img{display:block}@media (min-width:768px){.navbar>.container .navbar-brand,.navbar>.container-fluid .navbar-brand{margin-left:-15px}}.navbar-toggle{position:relative;float:right;margin-right:15px;padding:9px 10px;margin-top:8px;margin-bottom:8px;background-color:transparent;background-image:none;border:1px solid transparent;border-radius:4px}.navbar-toggle:focus{outline:0}.navbar-toggle .icon-bar{display:block;width:22px;height:2px;border-radius:1px}.navbar-toggle .icon-bar+.icon-bar{margin-top:4px}@media (min-width:768px){.navbar-toggle{display:none}}.navbar-nav{margin:7.5px -15px}.navbar-nav>li>a{padding-top:10px;padding-bottom:10px;line-height:20px}@media (max-width:767px){.navbar-nav .open .dropdown-menu{position:static;float:none;width:auto;margin-top:0;background-color:transparent;border:0;box-shadow:none}.navbar-nav .open .dropdown-menu>li>a,.navbar-nav .open .dropdown-menu .dropdown-header{padding:5px 15px 5px 25px}.navbar-nav .open .dropdown-menu>li>a{line-height:20px}.navbar-nav .open .dropdown-menu>li>a:hover,.navbar-nav .open .dropdown-menu>li>a:focus{background-image:none}}@media (min-width:768px){.navbar-nav{float:left;margin:0}.navbar-nav>li{float:left}.navbar-nav>li>a{padding-top:15px;padding-bottom:15px}}.navbar-form{margin-left:-15px;margin-right:-15px;padding:10px 15px;border-top:1px solid transparent;border-bottom:1px solid transparent;-webkit-box-shadow:inset 0 1px 0 rgba(255,255,255,0.1),0 1px 0 rgba(255,255,255,0.1);box-shadow:inset 0 1px 0 rgba(255,255,255,0.1),0 1px 0 rgba(255,255,255,0.1);margin-top:8px;margin-bottom:8px}@media (min-width:768px){.navbar-form .form-group{display:inline-block;margin-bottom:0;vertical-align:middle}.navbar-form .form-control{display:inline-block;width:auto;vertical-align:middle}.navbar-form .form-control-static{display:inline-block}.navbar-form .input-group{display:inline-table;vertical-align:middle}.navbar-form .input-group .input-group-addon,.navbar-form .input-group .input-group-btn,.navbar-form .input-group .form-control{width:auto}.navbar-form .input-group>.form-control{width:100%}.navbar-form .control-label{margin-bottom:0;vertical-align:middle}.navbar-form .radio,.navbar-form .checkbox{display:inline-block;margin-top:0;margin-bottom:0;vertical-align:middle}.navbar-form .radio label,.navbar-form .checkbox label{padding-left:0}.navbar-form .radio input[type="radio"],.navbar-form .checkbox input[type="checkbox"]{position:relative;margin-left:0}.navbar-form .has-feedback .form-control-feedback{top:0}}@media (max-width:767px){.navbar-form .form-group{margin-bottom:5px}.navbar-form .form-group:last-child{margin-bottom:0}}@media (min-width:768px){.navbar-form{width:auto;border:0;margin-left:0;margin-right:0;padding-top:0;padding-bottom:0;-webkit-box-shadow:none;box-shadow:none}}.navbar-nav>li>.dropdown-menu{margin-top:0;border-top-right-radius:0;border-top-left-radius:0}.navbar-fixed-bottom .navbar-nav>li>.dropdown-menu{margin-bottom:0;border-top-right-radius:4px;border-top-left-radius:4px;border-bottom-right-radius:0;border-bottom-left-radius:0}.navbar-btn{margin-top:8px;margin-bottom:8px}.navbar-btn.btn-sm{margin-top:10px;margin-bottom:10px}.navbar-btn.btn-xs{margin-top:14px;margin-bottom:14px}.navbar-text{margin-top:15px;margin-bottom:15px}@media (min-width:768px){.navbar-text{float:left;margin-left:15px;margin-right:15px}}@media (min-width:768px){.navbar-left{float:left !important}.navbar-right{float:right !important;margin-right:-15px}.navbar-right~.navbar-right{margin-right:0}}.navbar-default{background-color:#f8f8f8;border-color:#e7e7e7}.navbar-default .navbar-brand{color:#777}.navbar-default .navbar-brand:hover,.navbar-default .navbar-brand:focus{color:#5e5e5e;background-color:transparent}.navbar-default .navbar-text{color:#777}.navbar-default .navbar-nav>li>a{color:#777}.navbar-default .navbar-nav>li>a:hover,.navbar-default .navbar-nav>li>a:focus{color:#333;background-color:transparent}.navbar-default .navbar-nav>.active>a,.navbar-default .navbar-nav>.active>a:hover,.navbar-default .navbar-nav>.active>a:focus{color:#555;background-color:#e7e7e7}.navbar-default .navbar-nav>.disabled>a,.navbar-default .navbar-nav>.disabled>a:hover,.navbar-default .navbar-nav>.disabled>a:focus{color:#ccc;background-color:transparent}.navbar-default .navbar-toggle{border-color:#ddd}.navbar-default .navbar-toggle:hover,.navbar-default .navbar-toggle:focus{background-color:#ddd}.navbar-default .navbar-toggle .icon-bar{background-color:#888}.navbar-default .navbar-collapse,.navbar-default .navbar-form{border-color:#e7e7e7}.navbar-default .navbar-nav>.open>a,.navbar-default .navbar-nav>.open>a:hover,.navbar-default .navbar-nav>.open>a:focus{background-color:#e7e7e7;color:#555}@media (max-width:767px){.navbar-default .navbar-nav .open .dropdown-menu>li>a{color:#777}.navbar-default .navbar-nav .open .dropdown-menu>li>a:hover,.navbar-default .navbar-nav .open .dropdown-menu>li>a:focus{color:#333;background-color:transparent}.navbar-default .navbar-nav .open .dropdown-menu>.active>a,.navbar-default .navbar-nav .open .dropdown-menu>.active>a:hover,.navbar-default .navbar-nav .open .dropdown-menu>.active>a:focus{color:#555;background-color:#e7e7e7}.navbar-default .navbar-nav .open .dropdown-menu>.disabled>a,.navbar-default .navbar-nav .open .dropdown-menu>.disabled>a:hover,.navbar-default .navbar-nav .open .dropdown-menu>.disabled>a:focus{color:#ccc;background-color:transparent}}.navbar-default .navbar-link{color:#777}.navbar-default .navbar-link:hover{color:#333}.navbar-default .btn-link{color:#777}.navbar-default .btn-link:hover,.navbar-default .btn-link:focus{color:#333}.navbar-default .btn-link[disabled]:hover,fieldset[disabled] .navbar-default .btn-link:hover,.navbar-default .btn-link[disabled]:focus,fieldset[disabled] .navbar-default .btn-link:focus{color:#ccc}.navbar-inverse{background-color:#222;border-color:#080808}.navbar-inverse .navbar-brand{color:#9d9d9d}.navbar-inverse .navbar-brand:hover,.navbar-inverse .navbar-brand:focus{color:#fff;background-color:transparent}.navbar-inverse .navbar-text{color:#9d9d9d}.navbar-inverse .navbar-nav>li>a{color:#9d9d9d}.navbar-inverse .navbar-nav>li>a:hover,.navbar-inverse .navbar-nav>li>a:focus{color:#fff;background-color:transparent}.navbar-inverse .navbar-nav>.active>a,.navbar-inverse .navbar-nav>.active>a:hover,.navbar-inverse .navbar-nav>.active>a:focus{color:#fff;background-color:#080808}.navbar-inverse .navbar-nav>.disabled>a,.navbar-inverse .navbar-nav>.disabled>a:hover,.navbar-inverse .navbar-nav>.disabled>a:focus{color:#444;background-color:transparent}.navbar-inverse .navbar-toggle{border-color:#333}.navbar-inverse .navbar-toggle:hover,.navbar-inverse .navbar-toggle:focus{background-color:#333}.navbar-inverse .navbar-toggle .icon-bar{background-color:#fff}.navbar-inverse .navbar-collapse,.navbar-inverse .navbar-form{border-color:#101010}.navbar-inverse .navbar-nav>.open>a,.navbar-inverse .navbar-nav>.open>a:hover,.navbar-inverse .navbar-nav>.open>a:focus{background-color:#080808;color:#fff}@media (max-width:767px){.navbar-inverse .navbar-nav .open .dropdown-menu>.dropdown-header{border-color:#080808}.navbar-inverse .navbar-nav .open .dropdown-menu .divider{background-color:#080808}.navbar-inverse .navbar-nav .open .dropdown-menu>li>a{color:#9d9d9d}.navbar-inverse .navbar-nav .open .dropdown-menu>li>a:hover,.navbar-inverse .navbar-nav .open .dropdown-menu>li>a:focus{color:#fff;background-color:transparent}.navbar-inverse .navbar-nav .open .dropdown-menu>.active>a,.navbar-inverse .navbar-nav .open .dropdown-menu>.active>a:hover,.navbar-inverse .navbar-nav .open .dropdown-menu>.active>a:focus{color:#fff;background-color:#080808}.navbar-inverse .navbar-nav .open .dropdown-menu>.disabled>a,.navbar-inverse .navbar-nav .open .dropdown-menu>.disabled>a:hover,.navbar-inverse .navbar-nav .open .dropdown-menu>.disabled>a:focus{color:#444;background-color:transparent}}.navbar-inverse .navbar-link{color:#9d9d9d}.navbar-inverse .navbar-link:hover{color:#fff}.navbar-inverse .btn-link{color:#9d9d9d}.navbar-inverse .btn-link:hover,.navbar-inverse .btn-link:focus{color:#fff}.navbar-inverse .btn-link[disabled]:hover,fieldset[disabled] .navbar-inverse .btn-link:hover,.navbar-inverse .btn-link[disabled]:focus,fieldset[disabled] .navbar-inverse .btn-link:focus{color:#444}.breadcrumb{padding:8px 15px;margin-bottom:20px;list-style:none;background-color:#f5f5f5;border-radius:4px}.breadcrumb>li{display:inline-block}.breadcrumb>li+li:before{content:"/\00a0";padding:0 5px;color:#ccc}.breadcrumb>.active{color:#777}.pagination{display:inline-block;padding-left:0;margin:20px 0;border-radius:4px}.pagination>li{display:inline}.pagination>li>a,.pagination>li>span{position:relative;float:left;padding:6px 12px;line-height:1.42857143;text-decoration:none;color:#337ab7;background-color:#fff;border:1px solid #ddd;margin-left:-1px}.pagination>li:first-child>a,.pagination>li:first-child>span{margin-left:0;border-bottom-left-radius:4px;border-top-left-radius:4px}.pagination>li:last-child>a,.pagination>li:last-child>span{border-bottom-right-radius:4px;border-top-right-radius:4px}.pagination>li>a:hover,.pagination>li>span:hover,.pagination>li>a:focus,.pagination>li>span:focus{z-index:2;color:#23527c;background-color:#eee;border-color:#ddd}.pagination>.active>a,.pagination>.active>span,.pagination>.active>a:hover,.pagination>.active>span:hover,.pagination>.active>a:focus,.pagination>.active>span:focus{z-index:3;color:#fff;background-color:#337ab7;border-color:#337ab7;cursor:default}.pagination>.disabled>span,.pagination>.disabled>span:hover,.pagination>.disabled>span:focus,.pagination>.disabled>a,.pagination>.disabled>a:hover,.pagination>.disabled>a:focus{color:#777;background-color:#fff;border-color:#ddd;cursor:not-allowed}.pagination-lg>li>a,.pagination-lg>li>span{padding:10px 16px;font-size:18px;line-height:1.3333333}.pagination-lg>li:first-child>a,.pagination-lg>li:first-child>span{border-bottom-left-radius:6px;border-top-left-radius:6px}.pagination-lg>li:last-child>a,.pagination-lg>li:last-child>span{border-bottom-right-radius:6px;border-top-right-radius:6px}.pagination-sm>li>a,.pagination-sm>li>span{padding:5px 10px;font-size:12px;line-height:1.5}.pagination-sm>li:first-child>a,.pagination-sm>li:first-child>span{border-bottom-left-radius:3px;border-top-left-radius:3px}.pagination-sm>li:last-child>a,.pagination-sm>li:last-child>span{border-bottom-right-radius:3px;border-top-right-radius:3px}.pager{padding-left:0;margin:20px 0;list-style:none;text-align:center}.pager li{display:inline}.pager li>a,.pager li>span{display:inline-block;padding:5px 14px;background-color:#fff;border:1px solid #ddd;border-radius:15px}.pager li>a:hover,.pager li>a:focus{text-decoration:none;background-color:#eee}.pager .next>a,.pager .next>span{float:right}.pager .previous>a,.pager .previous>span{float:left}.pager .disabled>a,.pager .disabled>a:hover,.pager .disabled>a:focus,.pager .disabled>span{color:#777;background-color:#fff;cursor:not-allowed}.label{display:inline;padding:.2em .6em .3em;font-size:75%;font-weight:bold;line-height:1;color:#fff;text-align:center;white-space:nowrap;vertical-align:baseline;border-radius:.25em}a.label:hover,a.label:focus{color:#fff;text-decoration:none;cursor:pointer}.label:empty{display:none}.btn .label{position:relative;top:-1px}.label-default{background-color:#777}.label-default[href]:hover,.label-default[href]:focus{background-color:#5e5e5e}.label-primary{background-color:#337ab7}.label-primary[href]:hover,.label-primary[href]:focus{background-color:#286090}.label-success{background-color:#5cb85c}.label-success[href]:hover,.label-success[href]:focus{background-color:#449d44}.label-info{background-color:#5bc0de}.label-info[href]:hover,.label-info[href]:focus{background-color:#31b0d5}.label-warning{background-color:#f0ad4e}.label-warning[href]:hover,.label-warning[href]:focus{background-color:#ec971f}.label-danger{background-color:#d9534f}.label-danger[href]:hover,.label-danger[href]:focus{background-color:#c9302c}.badge{display:inline-block;min-width:10px;padding:3px 7px;font-size:12px;font-weight:bold;color:#fff;line-height:1;vertical-align:middle;white-space:nowrap;text-align:center;background-color:#777;border-radius:10px}.badge:empty{display:none}.btn .badge{position:relative;top:-1px}.btn-xs .badge,.btn-group-xs>.btn .badge{top:0;padding:1px 5px}a.badge:hover,a.badge:focus{color:#fff;text-decoration:none;cursor:pointer}.list-group-item.active>.badge,.nav-pills>.active>a>.badge{color:#337ab7;background-color:#fff}.list-group-item>.badge{float:right}.list-group-item>.badge+.badge{margin-right:5px}.nav-pills>li>a>.badge{margin-left:3px}.jumbotron{padding-top:30px;padding-bottom:30px;margin-bottom:30px;color:inherit;background-color:#eee}.jumbotron h1,.jumbotron .h1{color:inherit}.jumbotron p{margin-bottom:15px;font-size:21px;font-weight:200}.jumbotron>hr{border-top-color:#d5d5d5}.container .jumbotron,.container-fluid .jumbotron{border-radius:6px;padding-left:15px;padding-right:15px}.jumbotron .container{max-width:100%}@media screen and (min-width:768px){.jumbotron{padding-top:48px;padding-bottom:48px}.container .jumbotron,.container-fluid .jumbotron{padding-left:60px;padding-right:60px}.jumbotron h1,.jumbotron .h1{font-size:63px}}.thumbnail{display:block;padding:4px;margin-bottom:20px;line-height:1.42857143;background-color:#fff;border:1px solid #ddd;border-radius:4px;-webkit-transition:border .2s ease-in-out;-o-transition:border .2s ease-in-out;transition:border .2s ease-in-out}.thumbnail>img,.thumbnail a>img{margin-left:auto;margin-right:auto}a.thumbnail:hover,a.thumbnail:focus,a.thumbnail.active{border-color:#337ab7}.thumbnail .caption{padding:9px;color:#333}.alert{padding:15px;margin-bottom:20px;border:1px solid transparent;border-radius:4px}.alert h4{margin-top:0;color:inherit}.alert .alert-link{font-weight:bold}.alert>p,.alert>ul{margin-bottom:0}.alert>p+p{margin-top:5px}.alert-dismissable,.alert-dismissible{padding-right:35px}.alert-dismissable .close,.alert-dismissible .close{position:relative;top:-2px;right:-21px;color:inherit}.alert-success{background-color:#dff0d8;border-color:#d6e9c6;color:#3c763d}.alert-success hr{border-top-color:#c9e2b3}.alert-success .alert-link{color:#2b542c}.alert-info{background-color:#d9edf7;border-color:#bce8f1;color:#31708f}.alert-info hr{border-top-color:#a6e1ec}.alert-info .alert-link{color:#245269}.alert-warning{background-color:#fcf8e3;border-color:#faebcc;color:#8a6d3b}.alert-warning hr{border-top-color:#f7e1b5}.alert-warning .alert-link{color:#66512c}.alert-danger{background-color:#f2dede;border-color:#ebccd1;color:#a94442}.alert-danger hr{border-top-color:#e4b9c0}.alert-danger .alert-link{color:#843534}@-webkit-keyframes progress-bar-stripes{from{background-position:40px 0}to{background-position:0 0}}@keyframes progress-bar-stripes{from{background-position:40px 0}to{background-position:0 0}}.progress{overflow:hidden;height:20px;margin-bottom:20px;background-color:#f5f5f5;border-radius:4px;-webkit-box-shadow:inset 0 1px 2px rgba(0,0,0,0.1);box-shadow:inset 0 1px 2px rgba(0,0,0,0.1)}.progress-bar{float:left;width:0;height:100%;font-size:12px;line-height:20px;color:#fff;text-align:center;background-color:#337ab7;-webkit-box-shadow:inset 0 -1px 0 rgba(0,0,0,0.15);box-shadow:inset 0 -1px 0 rgba(0,0,0,0.15);-webkit-transition:width .6s ease;-o-transition:width .6s ease;transition:width .6s ease}.progress-striped .progress-bar,.progress-bar-striped{background-image:-webkit-linear-gradient(45deg, rgba(255,255,255,0.15) 25%, transparent 25%, transparent 50%, rgba(255,255,255,0.15) 50%, rgba(255,255,255,0.15) 75%, transparent 75%, transparent);background-image:-o-linear-gradient(45deg, rgba(255,255,255,0.15) 25%, transparent 25%, transparent 50%, rgba(255,255,255,0.15) 50%, rgba(255,255,255,0.15) 75%, transparent 75%, transparent);background-image:linear-gradient(45deg, rgba(255,255,255,0.15) 25%, transparent 25%, transparent 50%, rgba(255,255,255,0.15) 50%, rgba(255,255,255,0.15) 75%, transparent 75%, transparent);background-size:40px 40px}.progress.active .progress-bar,.progress-bar.active{-webkit-animation:progress-bar-stripes 2s linear infinite;-o-animation:progress-bar-stripes 2s linear infinite;animation:progress-bar-stripes 2s linear infinite}.progress-bar-success{background-color:#5cb85c}.progress-striped .progress-bar-success{background-image:-webkit-linear-gradient(45deg, rgba(255,255,255,0.15) 25%, transparent 25%, transparent 50%, rgba(255,255,255,0.15) 50%, rgba(255,255,255,0.15) 75%, transparent 75%, transparent);background-image:-o-linear-gradient(45deg, rgba(255,255,255,0.15) 25%, transparent 25%, transparent 50%, rgba(255,255,255,0.15) 50%, rgba(255,255,255,0.15) 75%, transparent 75%, transparent);background-image:linear-gradient(45deg, rgba(255,255,255,0.15) 25%, transparent 25%, transparent 50%, rgba(255,255,255,0.15) 50%, rgba(255,255,255,0.15) 75%, transparent 75%, transparent)}.progress-bar-info{background-color:#5bc0de}.progress-striped .progress-bar-info{background-image:-webkit-linear-gradient(45deg, rgba(255,255,255,0.15) 25%, transparent 25%, transparent 50%, rgba(255,255,255,0.15) 50%, rgba(255,255,255,0.15) 75%, transparent 75%, transparent);background-image:-o-linear-gradient(45deg, rgba(255,255,255,0.15) 25%, transparent 25%, transparent 50%, rgba(255,255,255,0.15) 50%, rgba(255,255,255,0.15) 75%, transparent 75%, transparent);background-image:linear-gradient(45deg, rgba(255,255,255,0.15) 25%, transparent 25%, transparent 50%, rgba(255,255,255,0.15) 50%, rgba(255,255,255,0.15) 75%, transparent 75%, transparent)}.progress-bar-warning{background-color:#f0ad4e}.progress-striped .progress-bar-warning{background-image:-webkit-linear-gradient(45deg, rgba(255,255,255,0.15) 25%, transparent 25%, transparent 50%, rgba(255,255,255,0.15) 50%, rgba(255,255,255,0.15) 75%, transparent 75%, transparent);background-image:-o-linear-gradient(45deg, rgba(255,255,255,0.15) 25%, transparent 25%, transparent 50%, rgba(255,255,255,0.15) 50%, rgba(255,255,255,0.15) 75%, transparent 75%, transparent);background-image:linear-gradient(45deg, rgba(255,255,255,0.15) 25%, transparent 25%, transparent 50%, rgba(255,255,255,0.15) 50%, rgba(255,255,255,0.15) 75%, transparent 75%, transparent)}.progress-bar-danger{background-color:#d9534f}.progress-striped .progress-bar-danger{background-image:-webkit-linear-gradient(45deg, rgba(255,255,255,0.15) 25%, transparent 25%, transparent 50%, rgba(255,255,255,0.15) 50%, rgba(255,255,255,0.15) 75%, transparent 75%, transparent);background-image:-o-linear-gradient(45deg, rgba(255,255,255,0.15) 25%, transparent 25%, transparent 50%, rgba(255,255,255,0.15) 50%, rgba(255,255,255,0.15) 75%, transparent 75%, transparent);background-image:linear-gradient(45deg, rgba(255,255,255,0.15) 25%, transparent 25%, transparent 50%, rgba(255,255,255,0.15) 50%, rgba(255,255,255,0.15) 75%, transparent 75%, transparent)}.media{margin-top:15px}.media:first-child{margin-top:0}.media,.media-body{zoom:1;overflow:hidden}.media-body{width:10000px}.media-object{display:block}.media-object.img-thumbnail{max-width:none}.media-right,.media>.pull-right{padding-left:10px}.media-left,.media>.pull-left{padding-right:10px}.media-left,.media-right,.media-body{display:table-cell;vertical-align:top}.media-middle{vertical-align:middle}.media-bottom{vertical-align:bottom}.media-heading{margin-top:0;margin-bottom:5px}.media-list{padding-left:0;list-style:none}.list-group{margin-bottom:20px;padding-left:0}.list-group-item{position:relative;display:block;padding:10px 15px;margin-bottom:-1px;background-color:#fff;border:1px solid #ddd}.list-group-item:first-child{border-top-right-radius:4px;border-top-left-radius:4px}.list-group-item:last-child{margin-bottom:0;border-bottom-right-radius:4px;border-bottom-left-radius:4px}a.list-group-item,button.list-group-item{color:#555}a.list-group-item .list-group-item-heading,button.list-group-item .list-group-item-heading{color:#333}a.list-group-item:hover,button.list-group-item:hover,a.list-group-item:focus,button.list-group-item:focus{text-decoration:none;color:#555;background-color:#f5f5f5}button.list-group-item{width:100%;text-align:left}.list-group-item.disabled,.list-group-item.disabled:hover,.list-group-item.disabled:focus{background-color:#eee;color:#777;cursor:not-allowed}.list-group-item.disabled .list-group-item-heading,.list-group-item.disabled:hover .list-group-item-heading,.list-group-item.disabled:focus .list-group-item-heading{color:inherit}.list-group-item.disabled .list-group-item-text,.list-group-item.disabled:hover .list-group-item-text,.list-group-item.disabled:focus .list-group-item-text{color:#777}.list-group-item.active,.list-group-item.active:hover,.list-group-item.active:focus{z-index:2;color:#fff;background-color:#337ab7;border-color:#337ab7}.list-group-item.active .list-group-item-heading,.list-group-item.active:hover .list-group-item-heading,.list-group-item.active:focus .list-group-item-heading,.list-group-item.active .list-group-item-heading>small,.list-group-item.active:hover .list-group-item-heading>small,.list-group-item.active:focus .list-group-item-heading>small,.list-group-item.active .list-group-item-heading>.small,.list-group-item.active:hover .list-group-item-heading>.small,.list-group-item.active:focus .list-group-item-heading>.small{color:inherit}.list-group-item.active .list-group-item-text,.list-group-item.active:hover .list-group-item-text,.list-group-item.active:focus .list-group-item-text{color:#c7ddef}.list-group-item-success{color:#3c763d;background-color:#dff0d8}a.list-group-item-success,button.list-group-item-success{color:#3c763d}a.list-group-item-success .list-group-item-heading,button.list-group-item-success .list-group-item-heading{color:inherit}a.list-group-item-success:hover,button.list-group-item-success:hover,a.list-group-item-success:focus,button.list-group-item-success:focus{color:#3c763d;background-color:#d0e9c6}a.list-group-item-success.active,button.list-group-item-success.active,a.list-group-item-success.active:hover,button.list-group-item-success.active:hover,a.list-group-item-success.active:focus,button.list-group-item-success.active:focus{color:#fff;background-color:#3c763d;border-color:#3c763d}.list-group-item-info{color:#31708f;background-color:#d9edf7}a.list-group-item-info,button.list-group-item-info{color:#31708f}a.list-group-item-info .list-group-item-heading,button.list-group-item-info .list-group-item-heading{color:inherit}a.list-group-item-info:hover,button.list-group-item-info:hover,a.list-group-item-info:focus,button.list-group-item-info:focus{color:#31708f;background-color:#c4e3f3}a.list-group-item-info.active,button.list-group-item-info.active,a.list-group-item-info.active:hover,button.list-group-item-info.active:hover,a.list-group-item-info.active:focus,button.list-group-item-info.active:focus{color:#fff;background-color:#31708f;border-color:#31708f}.list-group-item-warning{color:#8a6d3b;background-color:#fcf8e3}a.list-group-item-warning,button.list-group-item-warning{color:#8a6d3b}a.list-group-item-warning .list-group-item-heading,button.list-group-item-warning .list-group-item-heading{color:inherit}a.list-group-item-warning:hover,button.list-group-item-warning:hover,a.list-group-item-warning:focus,button.list-group-item-warning:focus{color:#8a6d3b;background-color:#faf2cc}a.list-group-item-warning.active,button.list-group-item-warning.active,a.list-group-item-warning.active:hover,button.list-group-item-warning.active:hover,a.list-group-item-warning.active:focus,button.list-group-item-warning.active:focus{color:#fff;background-color:#8a6d3b;border-color:#8a6d3b}.list-group-item-danger{color:#a94442;background-color:#f2dede}a.list-group-item-danger,button.list-group-item-danger{color:#a94442}a.list-group-item-danger .list-group-item-heading,button.list-group-item-danger .list-group-item-heading{color:inherit}a.list-group-item-danger:hover,button.list-group-item-danger:hover,a.list-group-item-danger:focus,button.list-group-item-danger:focus{color:#a94442;background-color:#ebcccc}a.list-group-item-danger.active,button.list-group-item-danger.active,a.list-group-item-danger.active:hover,button.list-group-item-danger.active:hover,a.list-group-item-danger.active:focus,button.list-group-item-danger.active:focus{color:#fff;background-color:#a94442;border-color:#a94442}.list-group-item-heading{margin-top:0;margin-bottom:5px}.list-group-item-text{margin-bottom:0;line-height:1.3}.panel{margin-bottom:20px;background-color:#fff;border:1px solid transparent;border-radius:4px;-webkit-box-shadow:0 1px 1px rgba(0,0,0,0.05);box-shadow:0 1px 1px rgba(0,0,0,0.05)}.panel-body{padding:15px}.panel-heading{padding:10px 15px;border-bottom:1px solid transparent;border-top-right-radius:3px;border-top-left-radius:3px}.panel-heading>.dropdown .dropdown-toggle{color:inherit}.panel-title{margin-top:0;margin-bottom:0;font-size:16px;color:inherit}.panel-title>a,.panel-title>small,.panel-title>.small,.panel-title>small>a,.panel-title>.small>a{color:inherit}.panel-footer{padding:10px 15px;background-color:#f5f5f5;border-top:1px solid #ddd;border-bottom-right-radius:3px;border-bottom-left-radius:3px}.panel>.list-group,.panel>.panel-collapse>.list-group{margin-bottom:0}.panel>.list-group .list-group-item,.panel>.panel-collapse>.list-group .list-group-item{border-width:1px 0;border-radius:0}.panel>.list-group:first-child .list-group-item:first-child,.panel>.panel-collapse>.list-group:first-child .list-group-item:first-child{border-top:0;border-top-right-radius:3px;border-top-left-radius:3px}.panel>.list-group:last-child .list-group-item:last-child,.panel>.panel-collapse>.list-group:last-child .list-group-item:last-child{border-bottom:0;border-bottom-right-radius:3px;border-bottom-left-radius:3px}.panel>.panel-heading+.panel-collapse>.list-group .list-group-item:first-child{border-top-right-radius:0;border-top-left-radius:0}.panel-heading+.list-group .list-group-item:first-child{border-top-width:0}.list-group+.panel-footer{border-top-width:0}.panel>.table,.panel>.table-responsive>.table,.panel>.panel-collapse>.table{margin-bottom:0}.panel>.table caption,.panel>.table-responsive>.table caption,.panel>.panel-collapse>.table caption{padding-left:15px;padding-right:15px}.panel>.table:first-child,.panel>.table-responsive:first-child>.table:first-child{border-top-right-radius:3px;border-top-left-radius:3px}.panel>.table:first-child>thead:first-child>tr:first-child,.panel>.table-responsive:first-child>.table:first-child>thead:first-child>tr:first-child,.panel>.table:first-child>tbody:first-child>tr:first-child,.panel>.table-responsive:first-child>.table:first-child>tbody:first-child>tr:first-child{border-top-left-radius:3px;border-top-right-radius:3px}.panel>.table:first-child>thead:first-child>tr:first-child td:first-child,.panel>.table-responsive:first-child>.table:first-child>thead:first-child>tr:first-child td:first-child,.panel>.table:first-child>tbody:first-child>tr:first-child td:first-child,.panel>.table-responsive:first-child>.table:first-child>tbody:first-child>tr:first-child td:first-child,.panel>.table:first-child>thead:first-child>tr:first-child th:first-child,.panel>.table-responsive:first-child>.table:first-child>thead:first-child>tr:first-child th:first-child,.panel>.table:first-child>tbody:first-child>tr:first-child th:first-child,.panel>.table-responsive:first-child>.table:first-child>tbody:first-child>tr:first-child th:first-child{border-top-left-radius:3px}.panel>.table:first-child>thead:first-child>tr:first-child td:last-child,.panel>.table-responsive:first-child>.table:first-child>thead:first-child>tr:first-child td:last-child,.panel>.table:first-child>tbody:first-child>tr:first-child td:last-child,.panel>.table-responsive:first-child>.table:first-child>tbody:first-child>tr:first-child td:last-child,.panel>.table:first-child>thead:first-child>tr:first-child th:last-child,.panel>.table-responsive:first-child>.table:first-child>thead:first-child>tr:first-child th:last-child,.panel>.table:first-child>tbody:first-child>tr:first-child th:last-child,.panel>.table-responsive:first-child>.table:first-child>tbody:first-child>tr:first-child th:last-child{border-top-right-radius:3px}.panel>.table:last-child,.panel>.table-responsive:last-child>.table:last-child{border-bottom-right-radius:3px;border-bottom-left-radius:3px}.panel>.table:last-child>tbody:last-child>tr:last-child,.panel>.table-responsive:last-child>.table:last-child>tbody:last-child>tr:last-child,.panel>.table:last-child>tfoot:last-child>tr:last-child,.panel>.table-responsive:last-child>.table:last-child>tfoot:last-child>tr:last-child{border-bottom-left-radius:3px;border-bottom-right-radius:3px}.panel>.table:last-child>tbody:last-child>tr:last-child td:first-child,.panel>.table-responsive:last-child>.table:last-child>tbody:last-child>tr:last-child td:first-child,.panel>.table:last-child>tfoot:last-child>tr:last-child td:first-child,.panel>.table-responsive:last-child>.table:last-child>tfoot:last-child>tr:last-child td:first-child,.panel>.table:last-child>tbody:last-child>tr:last-child th:first-child,.panel>.table-responsive:last-child>.table:last-child>tbody:last-child>tr:last-child th:first-child,.panel>.table:last-child>tfoot:last-child>tr:last-child th:first-child,.panel>.table-responsive:last-child>.table:last-child>tfoot:last-child>tr:last-child th:first-child{border-bottom-left-radius:3px}.panel>.table:last-child>tbody:last-child>tr:last-child td:last-child,.panel>.table-responsive:last-child>.table:last-child>tbody:last-child>tr:last-child td:last-child,.panel>.table:last-child>tfoot:last-child>tr:last-child td:last-child,.panel>.table-responsive:last-child>.table:last-child>tfoot:last-child>tr:last-child td:last-child,.panel>.table:last-child>tbody:last-child>tr:last-child th:last-child,.panel>.table-responsive:last-child>.table:last-child>tbody:last-child>tr:last-child th:last-child,.panel>.table:last-child>tfoot:last-child>tr:last-child th:last-child,.panel>.table-responsive:last-child>.table:last-child>tfoot:last-child>tr:last-child th:last-child{border-bottom-right-radius:3px}.panel>.panel-body+.table,.panel>.panel-body+.table-responsive,.panel>.table+.panel-body,.panel>.table-responsive+.panel-body{border-top:1px solid #ddd}.panel>.table>tbody:first-child>tr:first-child th,.panel>.table>tbody:first-child>tr:first-child td{border-top:0}.panel>.table-bordered,.panel>.table-responsive>.table-bordered{border:0}.panel>.table-bordered>thead>tr>th:first-child,.panel>.table-responsive>.table-bordered>thead>tr>th:first-child,.panel>.table-bordered>tbody>tr>th:first-child,.panel>.table-responsive>.table-bordered>tbody>tr>th:first-child,.panel>.table-bordered>tfoot>tr>th:first-child,.panel>.table-responsive>.table-bordered>tfoot>tr>th:first-child,.panel>.table-bordered>thead>tr>td:first-child,.panel>.table-responsive>.table-bordered>thead>tr>td:first-child,.panel>.table-bordered>tbody>tr>td:first-child,.panel>.table-responsive>.table-bordered>tbody>tr>td:first-child,.panel>.table-bordered>tfoot>tr>td:first-child,.panel>.table-responsive>.table-bordered>tfoot>tr>td:first-child{border-left:0}.panel>.table-bordered>thead>tr>th:last-child,.panel>.table-responsive>.table-bordered>thead>tr>th:last-child,.panel>.table-bordered>tbody>tr>th:last-child,.panel>.table-responsive>.table-bordered>tbody>tr>th:last-child,.panel>.table-bordered>tfoot>tr>th:last-child,.panel>.table-responsive>.table-bordered>tfoot>tr>th:last-child,.panel>.table-bordered>thead>tr>td:last-child,.panel>.table-responsive>.table-bordered>thead>tr>td:last-child,.panel>.table-bordered>tbody>tr>td:last-child,.panel>.table-responsive>.table-bordered>tbody>tr>td:last-child,.panel>.table-bordered>tfoot>tr>td:last-child,.panel>.table-responsive>.table-bordered>tfoot>tr>td:last-child{border-right:0}.panel>.table-bordered>thead>tr:first-child>td,.panel>.table-responsive>.table-bordered>thead>tr:first-child>td,.panel>.table-bordered>tbody>tr:first-child>td,.panel>.table-responsive>.table-bordered>tbody>tr:first-child>td,.panel>.table-bordered>thead>tr:first-child>th,.panel>.table-responsive>.table-bordered>thead>tr:first-child>th,.panel>.table-bordered>tbody>tr:first-child>th,.panel>.table-responsive>.table-bordered>tbody>tr:first-child>th{border-bottom:0}.panel>.table-bordered>tbody>tr:last-child>td,.panel>.table-responsive>.table-bordered>tbody>tr:last-child>td,.panel>.table-bordered>tfoot>tr:last-child>td,.panel>.table-responsive>.table-bordered>tfoot>tr:last-child>td,.panel>.table-bordered>tbody>tr:last-child>th,.panel>.table-responsive>.table-bordered>tbody>tr:last-child>th,.panel>.table-bordered>tfoot>tr:last-child>th,.panel>.table-responsive>.table-bordered>tfoot>tr:last-child>th{border-bottom:0}.panel>.table-responsive{border:0;margin-bottom:0}.panel-group{margin-bottom:20px}.panel-group .panel{margin-bottom:0;border-radius:4px}.panel-group .panel+.panel{margin-top:5px}.panel-group .panel-heading{border-bottom:0}.panel-group .panel-heading+.panel-collapse>.panel-body,.panel-group .panel-heading+.panel-collapse>.list-group{border-top:1px solid #ddd}.panel-group .panel-footer{border-top:0}.panel-group .panel-footer+.panel-collapse .panel-body{border-bottom:1px solid #ddd}.panel-default{border-color:#ddd}.panel-default>.panel-heading{color:#333;background-color:#f5f5f5;border-color:#ddd}.panel-default>.panel-heading+.panel-collapse>.panel-body{border-top-color:#ddd}.panel-default>.panel-heading .badge{color:#f5f5f5;background-color:#333}.panel-default>.panel-footer+.panel-collapse>.panel-body{border-bottom-color:#ddd}.panel-primary{border-color:#337ab7}.panel-primary>.panel-heading{color:#fff;background-color:#337ab7;border-color:#337ab7}.panel-primary>.panel-heading+.panel-collapse>.panel-body{border-top-color:#337ab7}.panel-primary>.panel-heading .badge{color:#337ab7;background-color:#fff}.panel-primary>.panel-footer+.panel-collapse>.panel-body{border-bottom-color:#337ab7}.panel-success{border-color:#d6e9c6}.panel-success>.panel-heading{color:#3c763d;background-color:#dff0d8;border-color:#d6e9c6}.panel-success>.panel-heading+.panel-collapse>.panel-body{border-top-color:#d6e9c6}.panel-success>.panel-heading .badge{color:#dff0d8;background-color:#3c763d}.panel-success>.panel-footer+.panel-collapse>.panel-body{border-bottom-color:#d6e9c6}.panel-info{border-color:#bce8f1}.panel-info>.panel-heading{color:#31708f;background-color:#d9edf7;border-color:#bce8f1}.panel-info>.panel-heading+.panel-collapse>.panel-body{border-top-color:#bce8f1}.panel-info>.panel-heading .badge{color:#d9edf7;background-color:#31708f}.panel-info>.panel-footer+.panel-collapse>.panel-body{border-bottom-color:#bce8f1}.panel-warning{border-color:#faebcc}.panel-warning>.panel-heading{color:#8a6d3b;background-color:#fcf8e3;border-color:#faebcc}.panel-warning>.panel-heading+.panel-collapse>.panel-body{border-top-color:#faebcc}.panel-warning>.panel-heading .badge{color:#fcf8e3;background-color:#8a6d3b}.panel-warning>.panel-footer+.panel-collapse>.panel-body{border-bottom-color:#faebcc}.panel-danger{border-color:#ebccd1}.panel-danger>.panel-heading{color:#a94442;background-color:#f2dede;border-color:#ebccd1}.panel-danger>.panel-heading+.panel-collapse>.panel-body{border-top-color:#ebccd1}.panel-danger>.panel-heading .badge{color:#f2dede;background-color:#a94442}.panel-danger>.panel-footer+.panel-collapse>.panel-body{border-bottom-color:#ebccd1}.embed-responsive{position:relative;display:block;height:0;padding:0;overflow:hidden}.embed-responsive .embed-responsive-item,.embed-responsive iframe,.embed-responsive embed,.embed-responsive object,.embed-responsive video{position:absolute;top:0;left:0;bottom:0;height:100%;width:100%;border:0}.embed-responsive-16by9{padding-bottom:56.25%}.embed-responsive-4by3{padding-bottom:75%}.well{min-height:20px;padding:19px;margin-bottom:20px;background-color:#f5f5f5;border:1px solid #e3e3e3;border-radius:4px;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,0.05);box-shadow:inset 0 1px 1px rgba(0,0,0,0.05)}.well blockquote{border-color:#ddd;border-color:rgba(0,0,0,0.15)}.well-lg{padding:24px;border-radius:6px}.well-sm{padding:9px;border-radius:3px}.close{float:right;font-size:21px;font-weight:bold;line-height:1;color:#000;text-shadow:0 1px 0 #fff;opacity:.2;filter:alpha(opacity=20)}.close:hover,.close:focus{color:#000;text-decoration:none;cursor:pointer;opacity:.5;filter:alpha(opacity=50)}button.close{padding:0;cursor:pointer;background:transparent;border:0;-webkit-appearance:none}.modal-open{overflow:hidden}.modal{display:none;overflow:hidden;position:fixed;top:0;right:0;bottom:0;left:0;z-index:1050;-webkit-overflow-scrolling:touch;outline:0}.modal.fade .modal-dialog{-webkit-transform:translate(0, -25%);-ms-transform:translate(0, -25%);-o-transform:translate(0, -25%);transform:translate(0, -25%);-webkit-transition:-webkit-transform 0.3s ease-out;-moz-transition:-moz-transform 0.3s ease-out;-o-transition:-o-transform 0.3s ease-out;transition:transform 0.3s ease-out}.modal.in .modal-dialog{-webkit-transform:translate(0, 0);-ms-transform:translate(0, 0);-o-transform:translate(0, 0);transform:translate(0, 0)}.modal-open .modal{overflow-x:hidden;overflow-y:auto}.modal-dialog{position:relative;width:auto;margin:10px}.modal-content{position:relative;background-color:#fff;border:1px solid #999;border:1px solid rgba(0,0,0,0.2);border-radius:6px;-webkit-box-shadow:0 3px 9px rgba(0,0,0,0.5);box-shadow:0 3px 9px rgba(0,0,0,0.5);background-clip:padding-box;outline:0}.modal-backdrop{position:fixed;top:0;right:0;bottom:0;left:0;z-index:1040;background-color:#000}.modal-backdrop.fade{opacity:0;filter:alpha(opacity=0)}.modal-backdrop.in{opacity:.5;filter:alpha(opacity=50)}.modal-header{padding:15px;border-bottom:1px solid #e5e5e5}.modal-header .close{margin-top:-2px}.modal-title{margin:0;line-height:1.42857143}.modal-body{position:relative;padding:15px}.modal-footer{padding:15px;text-align:right;border-top:1px solid #e5e5e5}.modal-footer .btn+.btn{margin-left:5px;margin-bottom:0}.modal-footer .btn-group .btn+.btn{margin-left:-1px}.modal-footer .btn-block+.btn-block{margin-left:0}.modal-scrollbar-measure{position:absolute;top:-9999px;width:50px;height:50px;overflow:scroll}@media (min-width:768px){.modal-dialog{width:600px;margin:30px auto}.modal-content{-webkit-box-shadow:0 5px 15px rgba(0,0,0,0.5);box-shadow:0 5px 15px rgba(0,0,0,0.5)}.modal-sm{width:300px}}@media (min-width:992px){.modal-lg{width:900px}}.tooltip{position:absolute;z-index:1070;display:block;font-family:"Helvetica Neue",Helvetica,Arial,sans-serif;font-style:normal;font-weight:normal;letter-spacing:normal;line-break:auto;line-height:1.42857143;text-align:left;text-align:start;text-decoration:none;text-shadow:none;text-transform:none;white-space:normal;word-break:normal;word-spacing:normal;word-wrap:normal;font-size:12px;opacity:0;filter:alpha(opacity=0)}.tooltip.in{opacity:.9;filter:alpha(opacity=90)}.tooltip.top{margin-top:-3px;padding:5px 0}.tooltip.right{margin-left:3px;padding:0 5px}.tooltip.bottom{margin-top:3px;padding:5px 0}.tooltip.left{margin-left:-3px;padding:0 5px}.tooltip-inner{max-width:200px;padding:3px 8px;color:#fff;text-align:center;background-color:#000;border-radius:4px}.tooltip-arrow{position:absolute;width:0;height:0;border-color:transparent;border-style:solid}.tooltip.top .tooltip-arrow{bottom:0;left:50%;margin-left:-5px;border-width:5px 5px 0;border-top-color:#000}.tooltip.top-left .tooltip-arrow{bottom:0;right:5px;margin-bottom:-5px;border-width:5px 5px 0;border-top-color:#000}.tooltip.top-right .tooltip-arrow{bottom:0;left:5px;margin-bottom:-5px;border-width:5px 5px 0;border-top-color:#000}.tooltip.right .tooltip-arrow{top:50%;left:0;margin-top:-5px;border-width:5px 5px 5px 0;border-right-color:#000}.tooltip.left .tooltip-arrow{top:50%;right:0;margin-top:-5px;border-width:5px 0 5px 5px;border-left-color:#000}.tooltip.bottom .tooltip-arrow{top:0;left:50%;margin-left:-5px;border-width:0 5px 5px;border-bottom-color:#000}.tooltip.bottom-left .tooltip-arrow{top:0;right:5px;margin-top:-5px;border-width:0 5px 5px;border-bottom-color:#000}.tooltip.bottom-right .tooltip-arrow{top:0;left:5px;margin-top:-5px;border-width:0 5px 5px;border-bottom-color:#000}.popover{position:absolute;top:0;left:0;z-index:1060;display:none;max-width:276px;padding:1px;font-family:"Helvetica Neue",Helvetica,Arial,sans-serif;font-style:normal;font-weight:normal;letter-spacing:normal;line-break:auto;line-height:1.42857143;text-align:left;text-align:start;text-decoration:none;text-shadow:none;text-transform:none;white-space:normal;word-break:normal;word-spacing:normal;word-wrap:normal;font-size:14px;background-color:#fff;background-clip:padding-box;border:1px solid #ccc;border:1px solid rgba(0,0,0,0.2);border-radius:6px;-webkit-box-shadow:0 5px 10px rgba(0,0,0,0.2);box-shadow:0 5px 10px rgba(0,0,0,0.2)}.popover.top{margin-top:-10px}.popover.right{margin-left:10px}.popover.bottom{margin-top:10px}.popover.left{margin-left:-10px}.popover-title{margin:0;padding:8px 14px;font-size:14px;background-color:#f7f7f7;border-bottom:1px solid #ebebeb;border-radius:5px 5px 0 0}.popover-content{padding:9px 14px}.popover>.arrow,.popover>.arrow:after{position:absolute;display:block;width:0;height:0;border-color:transparent;border-style:solid}.popover>.arrow{border-width:11px}.popover>.arrow:after{border-width:10px;content:""}.popover.top>.arrow{left:50%;margin-left:-11px;border-bottom-width:0;border-top-color:#999;border-top-color:rgba(0,0,0,0.25);bottom:-11px}.popover.top>.arrow:after{content:" ";bottom:1px;margin-left:-10px;border-bottom-width:0;border-top-color:#fff}.popover.right>.arrow{top:50%;left:-11px;margin-top:-11px;border-left-width:0;border-right-color:#999;border-right-color:rgba(0,0,0,0.25)}.popover.right>.arrow:after{content:" ";left:1px;bottom:-10px;border-left-width:0;border-right-color:#fff}.popover.bottom>.arrow{left:50%;margin-left:-11px;border-top-width:0;border-bottom-color:#999;border-bottom-color:rgba(0,0,0,0.25);top:-11px}.popover.bottom>.arrow:after{content:" ";top:1px;margin-left:-10px;border-top-width:0;border-bottom-color:#fff}.popover.left>.arrow{top:50%;right:-11px;margin-top:-11px;border-right-width:0;border-left-color:#999;border-left-color:rgba(0,0,0,0.25)}.popover.left>.arrow:after{content:" ";right:1px;border-right-width:0;border-left-color:#fff;bottom:-10px}.carousel{position:relative}.carousel-inner{position:relative;overflow:hidden;width:100%}.carousel-inner>.item{display:none;position:relative;-webkit-transition:.6s ease-in-out left;-o-transition:.6s ease-in-out left;transition:.6s ease-in-out left}.carousel-inner>.item>img,.carousel-inner>.item>a>img{line-height:1}@media all and (transform-3d),(-webkit-transform-3d){.carousel-inner>.item{-webkit-transition:-webkit-transform 0.6s ease-in-out;-moz-transition:-moz-transform 0.6s ease-in-out;-o-transition:-o-transform 0.6s ease-in-out;transition:transform 0.6s ease-in-out;-webkit-backface-visibility:hidden;-moz-backface-visibility:hidden;backface-visibility:hidden;-webkit-perspective:1000px;-moz-perspective:1000px;perspective:1000px}.carousel-inner>.item.next,.carousel-inner>.item.active.right{-webkit-transform:translate3d(100%, 0, 0);transform:translate3d(100%, 0, 0);left:0}.carousel-inner>.item.prev,.carousel-inner>.item.active.left{-webkit-transform:translate3d(-100%, 0, 0);transform:translate3d(-100%, 0, 0);left:0}.carousel-inner>.item.next.left,.carousel-inner>.item.prev.right,.carousel-inner>.item.active{-webkit-transform:translate3d(0, 0, 0);transform:translate3d(0, 0, 0);left:0}}.carousel-inner>.active,.carousel-inner>.next,.carousel-inner>.prev{display:block}.carousel-inner>.active{left:0}.carousel-inner>.next,.carousel-inner>.prev{position:absolute;top:0;width:100%}.carousel-inner>.next{left:100%}.carousel-inner>.prev{left:-100%}.carousel-inner>.next.left,.carousel-inner>.prev.right{left:0}.carousel-inner>.active.left{left:-100%}.carousel-inner>.active.right{left:100%}.carousel-control{position:absolute;top:0;left:0;bottom:0;width:15%;opacity:.5;filter:alpha(opacity=50);font-size:20px;color:#fff;text-align:center;text-shadow:0 1px 2px rgba(0,0,0,0.6);background-color:rgba(0,0,0,0)}.carousel-control.left{background-image:-webkit-linear-gradient(left, rgba(0,0,0,0.5) 0, rgba(0,0,0,0.0001) 100%);background-image:-o-linear-gradient(left, rgba(0,0,0,0.5) 0, rgba(0,0,0,0.0001) 100%);background-image:linear-gradient(to right, rgba(0,0,0,0.5) 0, rgba(0,0,0,0.0001) 100%);background-repeat:repeat-x;filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#80000000', endColorstr='#00000000', GradientType=1)}.carousel-control.right{left:auto;right:0;background-image:-webkit-linear-gradient(left, rgba(0,0,0,0.0001) 0, rgba(0,0,0,0.5) 100%);background-image:-o-linear-gradient(left, rgba(0,0,0,0.0001) 0, rgba(0,0,0,0.5) 100%);background-image:linear-gradient(to right, rgba(0,0,0,0.0001) 0, rgba(0,0,0,0.5) 100%);background-repeat:repeat-x;filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#00000000', endColorstr='#80000000', GradientType=1)}.carousel-control:hover,.carousel-control:focus{outline:0;color:#fff;text-decoration:none;opacity:.9;filter:alpha(opacity=90)}.carousel-control .icon-prev,.carousel-control .icon-next,.carousel-control .glyphicon-chevron-left,.carousel-control .glyphicon-chevron-right{position:absolute;top:50%;margin-top:-10px;z-index:5;display:inline-block}.carousel-control .icon-prev,.carousel-control .glyphicon-chevron-left{left:50%;margin-left:-10px}.carousel-control .icon-next,.carousel-control .glyphicon-chevron-right{right:50%;margin-right:-10px}.carousel-control .icon-prev,.carousel-control .icon-next{width:20px;height:20px;line-height:1;font-family:serif}.carousel-control .icon-prev:before{content:'\2039'}.carousel-control .icon-next:before{content:'\203a'}.carousel-indicators{position:absolute;bottom:10px;left:50%;z-index:15;width:60%;margin-left:-30%;padding-left:0;list-style:none;text-align:center}.carousel-indicators li{display:inline-block;width:10px;height:10px;margin:1px;text-indent:-999px;border:1px solid #fff;border-radius:10px;cursor:pointer;background-color:#000 \9;background-color:rgba(0,0,0,0)}.carousel-indicators .active{margin:0;width:12px;height:12px;background-color:#fff}.carousel-caption{position:absolute;left:15%;right:15%;bottom:20px;z-index:10;padding-top:20px;padding-bottom:20px;color:#fff;text-align:center;text-shadow:0 1px 2px rgba(0,0,0,0.6)}.carousel-caption .btn{text-shadow:none}@media screen and (min-width:768px){.carousel-control .glyphicon-chevron-left,.carousel-control .glyphicon-chevron-right,.carousel-control .icon-prev,.carousel-control .icon-next{width:30px;height:30px;margin-top:-10px;font-size:30px}.carousel-control .glyphicon-chevron-left,.carousel-control .icon-prev{margin-left:-10px}.carousel-control .glyphicon-chevron-right,.carousel-control .icon-next{margin-right:-10px}.carousel-caption{left:20%;right:20%;padding-bottom:30px}.carousel-indicators{bottom:20px}}.clearfix:before,.clearfix:after,.dl-horizontal dd:before,.dl-horizontal dd:after,.container:before,.container:after,.container-fluid:before,.container-fluid:after,.row:before,.row:after,.form-horizontal .form-group:before,.form-horizontal .form-group:after,.btn-toolbar:before,.btn-toolbar:after,.btn-group-vertical>.btn-group:before,.btn-group-vertical>.btn-group:after,.nav:before,.nav:after,.navbar:before,.navbar:after,.navbar-header:before,.navbar-header:after,.navbar-collapse:before,.navbar-collapse:after,.pager:before,.pager:after,.panel-body:before,.panel-body:after,.modal-header:before,.modal-header:after,.modal-footer:before,.modal-footer:after{content:" ";display:table}.clearfix:after,.dl-horizontal dd:after,.container:after,.container-fluid:after,.row:after,.form-horizontal .form-group:after,.btn-toolbar:after,.btn-group-vertical>.btn-group:after,.nav:after,.navbar:after,.navbar-header:after,.navbar-collapse:after,.pager:after,.panel-body:after,.modal-header:after,.modal-footer:after{clear:both}.center-block{display:block;margin-left:auto;margin-right:auto}.pull-right{float:right !important}.pull-left{float:left !important}.hide{display:none !important}.show{display:block !important}.invisible{visibility:hidden}.text-hide{font:0/0 a;color:transparent;text-shadow:none;background-color:transparent;border:0}.hidden{display:none !important}.affix{position:fixed}@-ms-viewport{width:device-width}.visible-xs,.visible-sm,.visible-md,.visible-lg{display:none !important}.visible-xs-block,.visible-xs-inline,.visible-xs-inline-block,.visible-sm-block,.visible-sm-inline,.visible-sm-inline-block,.visible-md-block,.visible-md-inline,.visible-md-inline-block,.visible-lg-block,.visible-lg-inline,.visible-lg-inline-block{display:none !important}@media (max-width:767px){.visible-xs{display:block !important}table.visible-xs{display:table !important}tr.visible-xs{display:table-row !important}th.visible-xs,td.visible-xs{display:table-cell !important}}@media (max-width:767px){.visible-xs-block{display:block !important}}@media (max-width:767px){.visible-xs-inline{display:inline !important}}@media (max-width:767px){.visible-xs-inline-block{display:inline-block !important}}@media (min-width:768px) and (max-width:991px){.visible-sm{display:block !important}table.visible-sm{display:table !important}tr.visible-sm{display:table-row !important}th.visible-sm,td.visible-sm{display:table-cell !important}}@media (min-width:768px) and (max-width:991px){.visible-sm-block{display:block !important}}@media (min-width:768px) and (max-width:991px){.visible-sm-inline{display:inline !important}}@media (min-width:768px) and (max-width:991px){.visible-sm-inline-block{display:inline-block !important}}@media (min-width:992px) and (max-width:1199px){.visible-md{display:block !important}table.visible-md{display:table !important}tr.visible-md{display:table-row !important}th.visible-md,td.visible-md{display:table-cell !important}}@media (min-width:992px) and (max-width:1199px){.visible-md-block{display:block !important}}@media (min-width:992px) and (max-width:1199px){.visible-md-inline{display:inline !important}}@media (min-width:992px) and (max-width:1199px){.visible-md-inline-block{display:inline-block !important}}@media (min-width:1200px){.visible-lg{display:block !important}table.visible-lg{display:table !important}tr.visible-lg{display:table-row !important}th.visible-lg,td.visible-lg{display:table-cell !important}}@media (min-width:1200px){.visible-lg-block{display:block !important}}@media (min-width:1200px){.visible-lg-inline{display:inline !important}}@media (min-width:1200px){.visible-lg-inline-block{display:inline-block !important}}@media (max-width:767px){.hidden-xs{display:none !important}}@media (min-width:768px) and (max-width:991px){.hidden-sm{display:none !important}}@media (min-width:992px) and (max-width:1199px){.hidden-md{display:none !important}}@media (min-width:1200px){.hidden-lg{display:none !important}}.visible-print{display:none !important}@media print{.visible-print{display:block !important}table.visible-print{display:table !important}tr.visible-print{display:table-row !important}th.visible-print,td.visible-print{display:table-cell !important}}.visible-print-block{display:none !important}@media print{.visible-print-block{display:block !important}}.visible-print-inline{display:none !important}@media print{.visible-print-inline{display:inline !important}}.visible-print-inline-block{display:none !important}@media print{.visible-print-inline-block{display:inline-block !important}}@media print{.hidden-print{display:none !important}}.panel-definition{border-color:#a2a2a2}.panel-definition>.panel-heading{color:#000;background-color:#eee;border-color:#a2a2a2}.panel-definition>.panel-heading+.panel-collapse>.panel-body{border-top-color:#a2a2a2}.panel-definition>.panel-heading .badge{color:#eee;background-color:#000}.panel-definition>.panel-footer+.panel-collapse>.panel-body{border-bottom-color:#a2a2a2}.json-schema-description:before{font-weight:bold;color:#555;text-transform:uppercase;content:"Description";padding-bottom:.5em;display:block}.json-schema-description:not(:last-child){padding-bottom:1.5em}.json-schema-properties:before{font-weight:bold;color:#555;text-transform:uppercase;content:"Properties";padding-bottom:.5em;display:block}.json-schema-properties:not(:last-child){padding-bottom:1.5em}.json-schema-properties dd:not(:last-child){padding-bottom:1em}.json-schema-properties dl{margin:0}.json-schema-example:before{font-weight:bold;color:#555;text-transform:uppercase;content:"Example";padding-bottom:.5em;display:block}.json-schema-example:not(:last-child){padding-bottom:1.5em}.json-schema-array-items:before{font-weight:bold;color:#555;text-transform:uppercase;content:"Items";padding-bottom:.5em;display:block}.json-schema-array-items:not(:last-child){padding-bottom:1.5em}.json-schema-allOf-inherited:before{font-weight:bold;color:#555;text-transform:uppercase;content:"Inherited";padding-bottom:.5em;display:block}.json-schema-allOf-inherited:not(:last-child){padding-bottom:1.5em}.json-schema-allOf-inherited ul{padding-left:0;list-style:none}.json-schema-anyOf>dl{border-left:2px solid #a2a2a2;padding-left:1em}.json-schema-anyOf>dl dt:not(:first-child):before{content:"or "}.json-schema-anyOf>dl dt:first-child:before{content:"either "}.json-schema-additionalProperties:before{font-weight:bold;color:#555;text-transform:uppercase;content:"Additional properties";padding-bottom:.5em;display:block}.json-schema-additionalProperties:not(:last-child){padding-bottom:1.5em}.json-inner-schema .json-schema-properties,.json-inner-schema .json-schema-array-items,.json-inner-schema .json-schema-description,.json-inner-schema .json-schema-example{padding-left:1em;margin-top:.5em;padding-bottom:.5em;border-left:2px solid #a2a2a2}.json-property-discriminator:before{display:inline;padding:.2em .6em .3em;font-size:75%;font-weight:bold;line-height:1;color:#fff;text-align:center;white-space:nowrap;vertical-align:baseline;border-radius:.25em;background-color:#777;content:"discriminator"}a.json-property-discriminator:before:hover,a.json-property-discriminator:before:focus{color:#fff;text-decoration:none;cursor:pointer}.json-property-discriminator:before:empty{display:none}.btn .json-property-discriminator:before{position:relative;top:-1px}.json-property-discriminator:before[href]:hover,.json-property-discriminator:before[href]:focus{background-color:#5e5e5e}.json-property-required:before{display:inline;padding:.2em .6em .3em;font-size:75%;font-weight:bold;line-height:1;color:#fff;text-align:center;white-space:nowrap;vertical-align:baseline;border-radius:.25em;background-color:#777;content:"required"}a.json-property-required:before:hover,a.json-property-required:before:focus{color:#fff;text-decoration:none;cursor:pointer}.json-property-required:before:empty{display:none}.btn .json-property-required:before{position:relative;top:-1px}.json-property-required:before[href]:hover,.json-property-required:before[href]:focus{background-color:#5e5e5e}.json-property-read-only:before{display:inline;padding:.2em .6em .3em;font-size:75%;font-weight:bold;line-height:1;color:#fff;text-align:center;white-space:nowrap;vertical-align:baseline;border-radius:.25em;background-color:#777;content:"read only"}a.json-property-read-only:before:hover,a.json-property-read-only:before:focus{color:#fff;text-decoration:none;cursor:pointer}.json-property-read-only:before:empty{display:none}.btn .json-property-read-only:before{position:relative;top:-1px}.json-property-read-only:before[href]:hover,.json-property-read-only:before[href]:focus{background-color:#5e5e5e}.json-property-type{font-style:italic;font-weight:100}.json-property-format{font-size:smaller}.json-property-enum{font-weight:lighter;font-size:small}.json-property-default-value{font-weight:lighter;font-size:small}.json-property-default-value:before{content:'(default: "'}.json-property-default-value:after{content:'")'}.json-property-enum-item{font-weight:lighter;font-size:small}.json-property-enum-item:before,.json-property-enum-item:after{content:"\""}.json-schema--reference{font-size:90%}.table.swagger--summary>tbody>tr>td.swagger--summary-path{vertical-align:middle}.table.swagger--summary>tbody>tr>td p{margin:0}.swagger--panel-operation-post{border-color:#78cc94}.swagger--panel-operation-post>.panel-heading{color:#333;background-color:#e7f6ec;border-color:#78cc94}.swagger--panel-operation-post>.panel-heading+.panel-collapse>.panel-body{border-top-color:#78cc94}.swagger--panel-operation-post>.panel-heading .badge{color:#e7f6ec;background-color:#333}.swagger--panel-operation-post>.panel-footer+.panel-collapse>.panel-body{border-bottom-color:#78cc94}.swagger--panel-operation-post .operation-name{font-weight:bold}.swagger--panel-operation-post .operation-summary{float:right !important}.swagger--panel-operation-get{border-color:#74a8d1}.swagger--panel-operation-get>.panel-heading{color:#333;background-color:#e7f0f7;border-color:#74a8d1}.swagger--panel-operation-get>.panel-heading+.panel-collapse>.panel-body{border-top-color:#74a8d1}.swagger--panel-operation-get>.panel-heading .badge{color:#e7f0f7;background-color:#333}.swagger--panel-operation-get>.panel-footer+.panel-collapse>.panel-body{border-bottom-color:#74a8d1}.swagger--panel-operation-get .operation-name{font-weight:bold}.swagger--panel-operation-get .operation-summary{float:right !important}.swagger--panel-operation-put{border-color:#d8ab71}.swagger--panel-operation-put>.panel-heading{color:#333;background-color:#f9f2e9;border-color:#d8ab71}.swagger--panel-operation-put>.panel-heading+.panel-collapse>.panel-body{border-top-color:#d8ab71}.swagger--panel-operation-put>.panel-heading .badge{color:#f9f2e9;background-color:#333}.swagger--panel-operation-put>.panel-footer+.panel-collapse>.panel-body{border-bottom-color:#d8ab71}.swagger--panel-operation-put .operation-name{font-weight:bold}.swagger--panel-operation-put .operation-summary{float:right !important}.swagger--panel-operation-patch{border-color:#ed7c59}.swagger--panel-operation-patch>.panel-heading{color:#333;background-color:#FCE9E3;border-color:#ed7c59}.swagger--panel-operation-patch>.panel-heading+.panel-collapse>.panel-body{border-top-color:#ed7c59}.swagger--panel-operation-patch>.panel-heading .badge{color:#FCE9E3;background-color:#333}.swagger--panel-operation-patch>.panel-footer+.panel-collapse>.panel-body{border-bottom-color:#ed7c59}.swagger--panel-operation-patch .operation-name{font-weight:bold}.swagger--panel-operation-patch .operation-summary{float:right !important}.swagger--panel-operation-options{border-color:#74a8d1}.swagger--panel-operation-options>.panel-heading{color:#333;background-color:#e7f0f7;border-color:#74a8d1}.swagger--panel-operation-options>.panel-heading+.panel-collapse>.panel-body{border-top-color:#74a8d1}.swagger--panel-operation-options>.panel-heading .badge{color:#e7f0f7;background-color:#333}.swagger--panel-operation-options>.panel-footer+.panel-collapse>.panel-body{border-bottom-color:#74a8d1}.swagger--panel-operation-options .operation-name{font-weight:bold}.swagger--panel-operation-options .operation-summary{float:right !important}.swagger--panel-operation-delete{border-color:#c77d7d}.swagger--panel-operation-delete>.panel-heading{color:#333;background-color:#f5e8e8;border-color:#c77d7d}.swagger--panel-operation-delete>.panel-heading+.panel-collapse>.panel-body{border-top-color:#c77d7d}.swagger--panel-operation-delete>.panel-heading .badge{color:#f5e8e8;background-color:#333}.swagger--panel-operation-delete>.panel-footer+.panel-collapse>.panel-body{border-bottom-color:#c77d7d}.swagger--panel-operation-delete .operation-name{font-weight:bold}.swagger--panel-operation-delete .operation-summary{float:right !important}.swagger--panel-operation-head{border-color:#f3ff34}.swagger--panel-operation-head>.panel-heading{color:#333;background-color:#fcffcd;border-color:#f3ff34}.swagger--panel-operation-head>.panel-heading+.panel-collapse>.panel-body{border-top-color:#f3ff34}.swagger--panel-operation-head>.panel-heading .badge{color:#fcffcd;background-color:#333}.swagger--panel-operation-head>.panel-footer+.panel-collapse>.panel-body{border-bottom-color:#f3ff34}.swagger--panel-operation-head .operation-name{font-weight:bold}.swagger--panel-operation-head .operation-summary{float:right !important}.sw-operation-description:before{font-weight:bold;color:#555;text-transform:uppercase;content:"Description";padding-bottom:.5em;display:block}.sw-operation-description:not(:last-child){padding-bottom:1.5em}.sw-request-params:before{font-weight:bold;color:#555;text-transform:uppercase;content:"Request parameters";padding-bottom:.5em;display:block}.sw-request-params:not(:last-child){padding-bottom:1.5em}.sw-request-body:before{font-weight:bold;color:#555;text-transform:uppercase;content:"Request body";padding-bottom:.5em;display:block}.sw-request-body:not(:last-child){padding-bottom:1.5em}.sw-responses:before{font-weight:bold;color:#555;text-transform:uppercase;content:"Responses";padding-bottom:.5em;display:block}.sw-responses:not(:last-child){padding-bottom:1.5em}.swagger--global:before{display:inline;padding:.2em .6em .3em;font-size:75%;font-weight:bold;line-height:1;color:#fff;text-align:center;white-space:nowrap;vertical-align:baseline;border-radius:.25em;background-color:#777;content:'global'}a.swagger--global:before:hover,a.swagger--global:before:focus{color:#fff;text-decoration:none;cursor:pointer}.swagger--global:before:empty{display:none}.btn .swagger--global:before{position:relative;top:-1px}.swagger--global:before[href]:hover,.swagger--global:before[href]:focus{background-color:#5e5e5e}table.table th.sw-param-key{width:auto}table.table th.sw-param-key:before{content:"Key"}table.table th.sw-param-name{width:auto}table.table th.sw-param-name:before{content:"Name"}table.table th.sw-param-description{width:auto}table.table th.sw-param-description:before{content:"Description"}table.table th.sw-param-data-type{width:auto}table.table th.sw-param-data-type:before{content:"Data type"}table.table th.sw-param-type{width:auto}table.table th.sw-param-type:before{content:"Type"}table.table th.sw-request-security-schema{width:auto}table.table th.sw-request-security-schema:before{content:"Schema"}table.table th.sw-request-security-scopes{width:auto}table.table th.sw-request-security-scopes:before{content:"Scopes"}table.table th.sw-response-header-name{width:auto}table.table th.sw-response-header-name:before{content:"Header"}table.table th.sw-response-header-description{width:auto}table.table th.sw-response-header-description:before{content:"Description"}table.table th.sw-response-header-data-type{width:auto}table.table th.sw-response-header-data-type:before{content:"Data type"}.sw-response-name-value{font-weight:bold}.sw-response-description-text{padding-bottom:.5em}code.highlight{padding:0}.panel-security-definition{border-color:#a2a2a2}.panel-security-definition>.panel-heading{color:#000;background-color:#eee;border-color:#a2a2a2}.panel-security-definition>.panel-heading+.panel-collapse>.panel-body{border-top-color:#a2a2a2}.panel-security-definition>.panel-heading .badge{color:#eee;background-color:#000}.panel-security-definition>.panel-footer+.panel-collapse>.panel-body{border-bottom-color:#a2a2a2}.sw-request-security:before{font-weight:bold;color:#555;text-transform:uppercase;content:"Security";padding-bottom:.5em;display:block}.sw-request-security:not(:last-child){padding-bottom:1.5em}.sw-security-definition-basic:before{color:#555;font-size:smaller;content:"(HTTP Basic Authentication)"}span.sw-default-value-header{font-weight:bold}.sw-info-version{font-weight:bold}.sw-info-version span{font-family:monospace;font-weight:normal;font-size:1.1em}</style>
+
+ <meta charset="UTF-8">
+ <title>Active and Available Inventory REST API.</title>
+</head>
+<body>
+<div class="container">
+ <h1>Active and Available Inventory REST API.</h1>
+ <p class="sw-info-version">Version: <span>v12</span></p>
+ <p><p><br/>
+[Differences versus the previous schema version](apidocs/aai_swagger_v13.diff)<br/>
+<br/>
+Copyright &copy; 2017 AT&amp;T Intellectual Property. All rights reserved.<br/>
+<br/>
+Licensed under the Creative Commons License, Attribution 4.0 Intl. (the &quot;License&quot;); you may not use this documentation except in compliance with the License.<br/>
+<br/>
+You may obtain a copy of the License at<br/>
+<br/>
+<a href="https://creativecommons.org/licenses/by/4.0">(https://creativecommons.org/licenses/by/4.0/)</a><br/>
+<br/>
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an &quot;AS IS&quot; 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.<br/>
+<br/>
+ECOMP and OpenECOMP are trademarks and service marks of AT&amp;T Intellectual Property.<br/>
+<br/>
+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.<br/></p>
+ </p>
+
+ <div id="sw-schemes" class="sw-default-value">
+ <span class="sw-default-value-header">Schemes:</span>
+ https
+ </div>
+
+
+ <h2 id="swagger--summary-tags">Summary</h2>
+
+ <h3 id="tag-CloudInfrastructure" class="swagger-summary-tag">Tag: CloudInfrastructure</h3>
+
+ <table class="table table-bordered table-condensed swagger--summary">
+ <thead>
+ <tr>
+ <th>Operation</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-get">GET /cloud-infrastructure/cloud-regions</a></td>
+ <td><p>returns cloud-regions</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--get">GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}</a></td>
+ <td><p>returns cloud-region</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--put">PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}</a></td>
+ <td><p>create or update an existing cloud-region</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--patch">PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}</a></td>
+ <td><p>update an existing cloud-region</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--delete">DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}</a></td>
+ <td><p>delete an existing cloud-region</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--availability-zones-get">GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones</a></td>
+ <td><p>returns availability-zones</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--availability-zones-availability-zone--availability-zone-name--get">GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}</a></td>
+ <td><p>returns availability-zone</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--availability-zones-availability-zone--availability-zone-name--put">PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}</a></td>
+ <td><p>create or update an existing availability-zone</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--availability-zones-availability-zone--availability-zone-name--patch">PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}</a></td>
+ <td><p>update an existing availability-zone</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--availability-zones-availability-zone--availability-zone-name--delete">DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}</a></td>
+ <td><p>delete an existing availability-zone</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--availability-zones-availability-zone--availability-zone-name--relationship-list-relationship-put">PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--availability-zones-availability-zone--availability-zone-name--relationship-list-relationship-delete">DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--dvs-switches-get">GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches</a></td>
+ <td><p>returns dvs-switches</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--dvs-switches-dvs-switch--switch-name--get">GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}</a></td>
+ <td><p>returns dvs-switch</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--dvs-switches-dvs-switch--switch-name--put">PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}</a></td>
+ <td><p>create or update an existing dvs-switch</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--dvs-switches-dvs-switch--switch-name--patch">PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}</a></td>
+ <td><p>update an existing dvs-switch</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--dvs-switches-dvs-switch--switch-name--delete">DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}</a></td>
+ <td><p>delete an existing dvs-switch</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--dvs-switches-dvs-switch--switch-name--relationship-list-relationship-put">PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--dvs-switches-dvs-switch--switch-name--relationship-list-relationship-delete">DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-get">GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors</a></td>
+ <td><p>returns flavors</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--get">GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}</a></td>
+ <td><p>returns flavor</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--put">PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}</a></td>
+ <td><p>create or update an existing flavor</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--patch">PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}</a></td>
+ <td><p>update an existing flavor</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--delete">DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}</a></td>
+ <td><p>delete an existing flavor</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--relationship-list-relationship-put">PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--relationship-list-relationship-delete">DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--group-assignments-get">GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments</a></td>
+ <td><p>returns group-assignments</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--group-assignments-group-assignment--group-id--get">GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}</a></td>
+ <td><p>returns group-assignment</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--group-assignments-group-assignment--group-id--put">PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}</a></td>
+ <td><p>create or update an existing group-assignment</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--group-assignments-group-assignment--group-id--patch">PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}</a></td>
+ <td><p>update an existing group-assignment</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--group-assignments-group-assignment--group-id--delete">DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}</a></td>
+ <td><p>delete an existing group-assignment</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--group-assignments-group-assignment--group-id--relationship-list-relationship-put">PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--group-assignments-group-assignment--group-id--relationship-list-relationship-delete">DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--images-get">GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images</a></td>
+ <td><p>returns images</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--images-image--image-id--get">GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}</a></td>
+ <td><p>returns image</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--images-image--image-id--put">PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}</a></td>
+ <td><p>create or update an existing image</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--images-image--image-id--patch">PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}</a></td>
+ <td><p>update an existing image</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--images-image--image-id--delete">DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}</a></td>
+ <td><p>delete an existing image</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--images-image--image-id--metadata-get">GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata</a></td>
+ <td><p>returns metadata</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--images-image--image-id--metadata-metadatum--metaname--get">GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}</a></td>
+ <td><p>returns metadatum</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--images-image--image-id--metadata-metadatum--metaname--put">PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}</a></td>
+ <td><p>create or update an existing metadatum</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--images-image--image-id--metadata-metadatum--metaname--patch">PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}</a></td>
+ <td><p>update an existing metadatum</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--images-image--image-id--metadata-metadatum--metaname--delete">DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}</a></td>
+ <td><p>delete an existing metadatum</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--images-image--image-id--relationship-list-relationship-put">PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--images-image--image-id--relationship-list-relationship-delete">DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--oam-networks-get">GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks</a></td>
+ <td><p>returns oam-networks</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--oam-networks-oam-network--network-uuid--get">GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}</a></td>
+ <td><p>returns oam-network</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--oam-networks-oam-network--network-uuid--put">PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}</a></td>
+ <td><p>create or update an existing oam-network</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--oam-networks-oam-network--network-uuid--patch">PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}</a></td>
+ <td><p>update an existing oam-network</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--oam-networks-oam-network--network-uuid--delete">DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}</a></td>
+ <td><p>delete an existing oam-network</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--oam-networks-oam-network--network-uuid--relationship-list-relationship-put">PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--oam-networks-oam-network--network-uuid--relationship-list-relationship-delete">DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--relationship-list-relationship-put">PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--relationship-list-relationship-delete">DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--snapshots-get">GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots</a></td>
+ <td><p>returns snapshots</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--snapshots-snapshot--snapshot-id--get">GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}</a></td>
+ <td><p>returns snapshot</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--snapshots-snapshot--snapshot-id--put">PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}</a></td>
+ <td><p>create or update an existing snapshot</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--snapshots-snapshot--snapshot-id--patch">PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}</a></td>
+ <td><p>update an existing snapshot</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--snapshots-snapshot--snapshot-id--delete">DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}</a></td>
+ <td><p>delete an existing snapshot</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--snapshots-snapshot--snapshot-id--relationship-list-relationship-put">PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--snapshots-snapshot--snapshot-id--relationship-list-relationship-delete">DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-get">GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants</a></td>
+ <td><p>returns tenants</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--get">GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}</a></td>
+ <td><p>returns tenant</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--put">PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}</a></td>
+ <td><p>create or update an existing tenant</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--patch">PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}</a></td>
+ <td><p>update an existing tenant</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--delete">DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}</a></td>
+ <td><p>delete an existing tenant</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--relationship-list-relationship-put">PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--relationship-list-relationship-delete">DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--vservers-get">GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers</a></td>
+ <td><p>returns vservers</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--vservers-vserver--vserver-id--get">GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}</a></td>
+ <td><p>returns vserver</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--vservers-vserver--vserver-id--put">PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}</a></td>
+ <td><p>create or update an existing vserver</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--vservers-vserver--vserver-id--patch">PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}</a></td>
+ <td><p>update an existing vserver</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--vservers-vserver--vserver-id--delete">DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}</a></td>
+ <td><p>delete an existing vserver</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--vservers-vserver--vserver-id--l-interfaces-get">GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces</a></td>
+ <td><p>returns l-interfaces</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>returns l-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>create or update an existing l-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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--patch">PATCH /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}</a></td>
+ <td><p>update an existing l-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>delete an existing l-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>returns l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>create or update an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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--patch">PATCH /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}</a></td>
+ <td><p>update an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>delete an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>returns l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>create or update an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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--patch">PATCH /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}</a></td>
+ <td><p>update an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>delete an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>returns sriov-vfs</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>returns sriov-vf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>create or update an existing sriov-vf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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--patch">PATCH /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}</a></td>
+ <td><p>update an existing sriov-vf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>delete an existing sriov-vf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>returns vlans</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>returns vlan</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>create or update an existing vlan</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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--patch">PATCH /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}</a></td>
+ <td><p>update an existing vlan</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>delete an existing vlan</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>returns l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>create or update an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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--patch">PATCH /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}</a></td>
+ <td><p>update an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>delete an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>returns l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>create or update an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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--patch">PATCH /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}</a></td>
+ <td><p>update an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>delete an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--vservers-vserver--vserver-id--relationship-list-relationship-put">PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--vservers-vserver--vserver-id--relationship-list-relationship-delete">DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--vservers-vserver--vserver-id--volumes-get">GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes</a></td>
+ <td><p>returns volumes</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}</a></td>
+ <td><p>returns volume</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}</a></td>
+ <td><p>create or update an existing volume</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--vservers-vserver--vserver-id--volumes-volume--volume-id--patch">PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}</a></td>
+ <td><p>update an existing volume</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}</a></td>
+ <td><p>delete an existing volume</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv4-address-list--vip-ipv4-address--get">GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}</a></td>
+ <td><p>returns vip-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv4-address-list--vip-ipv4-address--put">PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}</a></td>
+ <td><p>create or update an existing vip-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv4-address-list--vip-ipv4-address--patch">PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}</a></td>
+ <td><p>update an existing vip-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv4-address-list--vip-ipv4-address--delete">DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}</a></td>
+ <td><p>delete an existing vip-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv4-address-list--vip-ipv4-address--relationship-list-relationship-put">PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv4-address-list--vip-ipv4-address--relationship-list-relationship-delete">DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv6-address-list--vip-ipv6-address--get">GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}</a></td>
+ <td><p>returns vip-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv6-address-list--vip-ipv6-address--put">PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}</a></td>
+ <td><p>create or update an existing vip-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv6-address-list--vip-ipv6-address--patch">PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}</a></td>
+ <td><p>update an existing vip-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv6-address-list--vip-ipv6-address--delete">DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}</a></td>
+ <td><p>delete an existing vip-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv6-address-list--vip-ipv6-address--relationship-list-relationship-put">PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv6-address-list--vip-ipv6-address--relationship-list-relationship-delete">DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--volume-groups-get">GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups</a></td>
+ <td><p>returns volume-groups</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--volume-groups-volume-group--volume-group-id--get">GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}</a></td>
+ <td><p>returns volume-group</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--volume-groups-volume-group--volume-group-id--put">PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}</a></td>
+ <td><p>create or update an existing volume-group</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--volume-groups-volume-group--volume-group-id--patch">PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}</a></td>
+ <td><p>update an existing volume-group</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--volume-groups-volume-group--volume-group-id--delete">DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}</a></td>
+ <td><p>delete an existing volume-group</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--volume-groups-volume-group--volume-group-id--relationship-list-relationship-put">PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--volume-groups-volume-group--volume-group-id--relationship-list-relationship-delete">DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-complexes-get">GET /cloud-infrastructure/complexes</a></td>
+ <td><p>returns complexes</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-complexes-complex--physical-location-id--get">GET /cloud-infrastructure/complexes/complex/{physical-location-id}</a></td>
+ <td><p>returns complex</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-complexes-complex--physical-location-id--put">PUT /cloud-infrastructure/complexes/complex/{physical-location-id}</a></td>
+ <td><p>create or update an existing complex</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-complexes-complex--physical-location-id--patch">PATCH /cloud-infrastructure/complexes/complex/{physical-location-id}</a></td>
+ <td><p>update an existing complex</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-complexes-complex--physical-location-id--delete">DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}</a></td>
+ <td><p>delete an existing complex</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-complexes-complex--physical-location-id--ctag-pools-get">GET /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools</a></td>
+ <td><p>returns ctag-pools</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-complexes-complex--physical-location-id--ctag-pools-ctag-pool--target-pe---availability-zone-name--get">GET /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}</a></td>
+ <td><p>returns ctag-pool</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-complexes-complex--physical-location-id--ctag-pools-ctag-pool--target-pe---availability-zone-name--put">PUT /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}</a></td>
+ <td><p>create or update an existing ctag-pool</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-complexes-complex--physical-location-id--ctag-pools-ctag-pool--target-pe---availability-zone-name--patch">PATCH /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}</a></td>
+ <td><p>update an existing ctag-pool</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-complexes-complex--physical-location-id--ctag-pools-ctag-pool--target-pe---availability-zone-name--delete">DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}</a></td>
+ <td><p>delete an existing ctag-pool</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-complexes-complex--physical-location-id--ctag-pools-ctag-pool--target-pe---availability-zone-name--relationship-list-relationship-put">PUT /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-complexes-complex--physical-location-id--ctag-pools-ctag-pool--target-pe---availability-zone-name--relationship-list-relationship-delete">DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-complexes-complex--physical-location-id--relationship-list-relationship-put">PUT /cloud-infrastructure/complexes/complex/{physical-location-id}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-complexes-complex--physical-location-id--relationship-list-relationship-delete">DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-network-profiles-get">GET /cloud-infrastructure/network-profiles</a></td>
+ <td><p>returns network-profiles</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-network-profiles-network-profile--nm-profile-name--get">GET /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}</a></td>
+ <td><p>returns network-profile</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-network-profiles-network-profile--nm-profile-name--put">PUT /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}</a></td>
+ <td><p>create or update an existing network-profile</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-network-profiles-network-profile--nm-profile-name--patch">PATCH /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}</a></td>
+ <td><p>update an existing network-profile</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-network-profiles-network-profile--nm-profile-name--delete">DELETE /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}</a></td>
+ <td><p>delete an existing network-profile</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-network-profiles-network-profile--nm-profile-name--relationship-list-relationship-put">PUT /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-network-profiles-network-profile--nm-profile-name--relationship-list-relationship-delete">DELETE /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-operational-environments-get">GET /cloud-infrastructure/operational-environments</a></td>
+ <td><p>returns operational-environments</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-operational-environments-operational-environment--operational-environment-id--get">GET /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}</a></td>
+ <td><p>returns operational-environment</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-operational-environments-operational-environment--operational-environment-id--put">PUT /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}</a></td>
+ <td><p>create or update an existing operational-environment</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-operational-environments-operational-environment--operational-environment-id--patch">PATCH /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}</a></td>
+ <td><p>update an existing operational-environment</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-operational-environments-operational-environment--operational-environment-id--delete">DELETE /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}</a></td>
+ <td><p>delete an existing operational-environment</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-operational-environments-operational-environment--operational-environment-id--relationship-list-relationship-put">PUT /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-operational-environments-operational-environment--operational-environment-id--relationship-list-relationship-delete">DELETE /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-get">GET /cloud-infrastructure/pservers</a></td>
+ <td><p>returns pservers</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--get">GET /cloud-infrastructure/pservers/pserver/{hostname}</a></td>
+ <td><p>returns pserver</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--put">PUT /cloud-infrastructure/pservers/pserver/{hostname}</a></td>
+ <td><p>create or update an existing pserver</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--patch">PATCH /cloud-infrastructure/pservers/pserver/{hostname}</a></td>
+ <td><p>update an existing pserver</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--delete">DELETE /cloud-infrastructure/pservers/pserver/{hostname}</a></td>
+ <td><p>delete an existing pserver</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-get">GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces</a></td>
+ <td><p>returns lag-interfaces</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--get">GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}</a></td>
+ <td><p>returns lag-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--put">PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}</a></td>
+ <td><p>create or update an existing lag-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--patch">PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}</a></td>
+ <td><p>update an existing lag-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--delete">DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}</a></td>
+ <td><p>delete an existing lag-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-get">GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces</a></td>
+ <td><p>returns l-interfaces</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--get">GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</a></td>
+ <td><p>returns l-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--put">PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</a></td>
+ <td><p>create or update an existing l-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--patch">PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</a></td>
+ <td><p>update an existing l-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--delete">DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</a></td>
+ <td><p>delete an existing l-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>returns l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>create or update an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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--patch">PATCH /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}</a></td>
+ <td><p>update an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>delete an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>returns l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>create or update an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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--patch">PATCH /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}</a></td>
+ <td><p>update an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>delete an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--relationship-list-relationship-put">PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--relationship-list-relationship-delete">DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-get">GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs</a></td>
+ <td><p>returns sriov-vfs</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}</a></td>
+ <td><p>returns sriov-vf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}</a></td>
+ <td><p>create or update an existing sriov-vf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--patch">PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}</a></td>
+ <td><p>update an existing sriov-vf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}</a></td>
+ <td><p>delete an existing sriov-vf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-get">GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans</a></td>
+ <td><p>returns vlans</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--get">GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</a></td>
+ <td><p>returns vlan</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--put">PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</a></td>
+ <td><p>create or update an existing vlan</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--patch">PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</a></td>
+ <td><p>update an existing vlan</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--delete">DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</a></td>
+ <td><p>delete an existing vlan</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>returns l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>create or update an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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--patch">PATCH /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}</a></td>
+ <td><p>update an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>delete an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>returns l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>create or update an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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--patch">PATCH /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}</a></td>
+ <td><p>update an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>delete an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--relationship-list-relationship-put">PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--relationship-list-relationship-delete">DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-get">GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces</a></td>
+ <td><p>returns p-interfaces</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--get">GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}</a></td>
+ <td><p>returns p-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--put">PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}</a></td>
+ <td><p>create or update an existing p-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--patch">PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}</a></td>
+ <td><p>update an existing p-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--delete">DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}</a></td>
+ <td><p>delete an existing p-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-get">GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces</a></td>
+ <td><p>returns l-interfaces</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--get">GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</a></td>
+ <td><p>returns l-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--put">PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</a></td>
+ <td><p>create or update an existing l-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--patch">PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</a></td>
+ <td><p>update an existing l-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--delete">DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</a></td>
+ <td><p>delete an existing l-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>returns l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>create or update an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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--patch">PATCH /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}</a></td>
+ <td><p>update an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>delete an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>returns l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>create or update an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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--patch">PATCH /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}</a></td>
+ <td><p>update an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>delete an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--relationship-list-relationship-put">PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--relationship-list-relationship-delete">DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-get">GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs</a></td>
+ <td><p>returns sriov-vfs</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}</a></td>
+ <td><p>returns sriov-vf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}</a></td>
+ <td><p>create or update an existing sriov-vf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--patch">PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}</a></td>
+ <td><p>update an existing sriov-vf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}</a></td>
+ <td><p>delete an existing sriov-vf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-get">GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans</a></td>
+ <td><p>returns vlans</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--get">GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</a></td>
+ <td><p>returns vlan</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--put">PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</a></td>
+ <td><p>create or update an existing vlan</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--patch">PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</a></td>
+ <td><p>update an existing vlan</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--delete">DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</a></td>
+ <td><p>delete an existing vlan</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>returns l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>create or update an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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--patch">PATCH /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}</a></td>
+ <td><p>update an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>delete an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>returns l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>create or update an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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--patch">PATCH /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}</a></td>
+ <td><p>update an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>delete an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--relationship-list-relationship-put">PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--relationship-list-relationship-delete">DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--sriov-pfs-get">GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs</a></td>
+ <td><p>returns sriov-pfs</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--get">GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}</a></td>
+ <td><p>returns sriov-pf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--put">PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}</a></td>
+ <td><p>create or update an existing sriov-pf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--patch">PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}</a></td>
+ <td><p>update an existing sriov-pf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--delete">DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}</a></td>
+ <td><p>delete an existing sriov-pf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--relationship-list-relationship-put">PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--relationship-list-relationship-delete">DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--relationship-list-relationship-put">PUT /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-pservers-pserver--hostname--relationship-list-relationship-delete">DELETE /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-virtual-data-centers-get">GET /cloud-infrastructure/virtual-data-centers</a></td>
+ <td><p>returns virtual-data-centers</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-virtual-data-centers-virtual-data-center--vdc-id--get">GET /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}</a></td>
+ <td><p>returns virtual-data-center</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-virtual-data-centers-virtual-data-center--vdc-id--put">PUT /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}</a></td>
+ <td><p>create or update an existing virtual-data-center</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-virtual-data-centers-virtual-data-center--vdc-id--patch">PATCH /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}</a></td>
+ <td><p>update an existing virtual-data-center</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-virtual-data-centers-virtual-data-center--vdc-id--delete">DELETE /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}</a></td>
+ <td><p>delete an existing virtual-data-center</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-virtual-data-centers-virtual-data-center--vdc-id--relationship-list-relationship-put">PUT /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--cloud-infrastructure-virtual-data-centers-virtual-data-center--vdc-id--relationship-list-relationship-delete">DELETE /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+
+ <h3 id="tag-Business" class="swagger-summary-tag">Tag: Business</h3>
+
+ <table class="table table-bordered table-condensed swagger--summary">
+ <thead>
+ <tr>
+ <th>Operation</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><a href="#operation--business-connectors-get">GET /business/connectors</a></td>
+ <td><p>returns connectors</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-connectors-connector--resource-instance-id--get">GET /business/connectors/connector/{resource-instance-id}</a></td>
+ <td><p>returns connector</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-connectors-connector--resource-instance-id--put">PUT /business/connectors/connector/{resource-instance-id}</a></td>
+ <td><p>create or update an existing connector</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-connectors-connector--resource-instance-id--patch">PATCH /business/connectors/connector/{resource-instance-id}</a></td>
+ <td><p>update an existing connector</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-connectors-connector--resource-instance-id--delete">DELETE /business/connectors/connector/{resource-instance-id}</a></td>
+ <td><p>delete an existing connector</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-connectors-connector--resource-instance-id--metadata-get">GET /business/connectors/connector/{resource-instance-id}/metadata</a></td>
+ <td><p>returns metadata</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-connectors-connector--resource-instance-id--metadata-metadatum--metaname--get">GET /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}</a></td>
+ <td><p>returns metadatum</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-connectors-connector--resource-instance-id--metadata-metadatum--metaname--put">PUT /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}</a></td>
+ <td><p>create or update an existing metadatum</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-connectors-connector--resource-instance-id--metadata-metadatum--metaname--patch">PATCH /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}</a></td>
+ <td><p>update an existing metadatum</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-connectors-connector--resource-instance-id--metadata-metadatum--metaname--delete">DELETE /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}</a></td>
+ <td><p>delete an existing metadatum</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-connectors-connector--resource-instance-id--relationship-list-relationship-put">PUT /business/connectors/connector/{resource-instance-id}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-connectors-connector--resource-instance-id--relationship-list-relationship-delete">DELETE /business/connectors/connector/{resource-instance-id}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-customers-get">GET /business/customers</a></td>
+ <td><p>returns customers</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-customers-customer--global-customer-id--get">GET /business/customers/customer/{global-customer-id}</a></td>
+ <td><p>returns customer</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-customers-customer--global-customer-id--put">PUT /business/customers/customer/{global-customer-id}</a></td>
+ <td><p>create or update an existing customer</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-customers-customer--global-customer-id--patch">PATCH /business/customers/customer/{global-customer-id}</a></td>
+ <td><p>update an existing customer</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-customers-customer--global-customer-id--delete">DELETE /business/customers/customer/{global-customer-id}</a></td>
+ <td><p>delete an existing customer</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-customers-customer--global-customer-id--relationship-list-relationship-put">PUT /business/customers/customer/{global-customer-id}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-customers-customer--global-customer-id--relationship-list-relationship-delete">DELETE /business/customers/customer/{global-customer-id}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-customers-customer--global-customer-id--service-subscriptions-get">GET /business/customers/customer/{global-customer-id}/service-subscriptions</a></td>
+ <td><p>returns service-subscriptions</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--get">GET /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}</a></td>
+ <td><p>returns service-subscription</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--put">PUT /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}</a></td>
+ <td><p>create or update an existing service-subscription</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--patch">PATCH /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}</a></td>
+ <td><p>update an existing service-subscription</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--delete">DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}</a></td>
+ <td><p>delete an existing service-subscription</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--relationship-list-relationship-put">PUT /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--relationship-list-relationship-delete">DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--service-instances-get">GET /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances</a></td>
+ <td><p>returns service-instances</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--service-instances-service-instance--service-instance-id--get">GET /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}</a></td>
+ <td><p>returns service-instance</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--service-instances-service-instance--service-instance-id--put">PUT /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}</a></td>
+ <td><p>create or update an existing service-instance</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--service-instances-service-instance--service-instance-id--patch">PATCH /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}</a></td>
+ <td><p>update an existing service-instance</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--service-instances-service-instance--service-instance-id--delete">DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}</a></td>
+ <td><p>delete an existing service-instance</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--service-instances-service-instance--service-instance-id--allotted-resources-get">GET /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources</a></td>
+ <td><p>returns allotted-resources</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>returns allotted-resource</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>create or update an existing allotted-resource</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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--patch">PATCH /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}</a></td>
+ <td><p>update an existing allotted-resource</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>delete an existing allotted-resource</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>returns tunnel-xconnects</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>returns tunnel-xconnect</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>create or update an existing tunnel-xconnect</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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--patch">PATCH /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}</a></td>
+ <td><p>update an existing tunnel-xconnect</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>delete an existing tunnel-xconnect</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--service-instances-service-instance--service-instance-id--metadata-get">GET /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata</a></td>
+ <td><p>returns metadata</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--service-instances-service-instance--service-instance-id--metadata-metadatum--metaname--get">GET /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}</a></td>
+ <td><p>returns metadatum</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--service-instances-service-instance--service-instance-id--metadata-metadatum--metaname--put">PUT /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}</a></td>
+ <td><p>create or update an existing metadatum</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--service-instances-service-instance--service-instance-id--metadata-metadatum--metaname--patch">PATCH /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}</a></td>
+ <td><p>update an existing metadatum</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--service-instances-service-instance--service-instance-id--metadata-metadatum--metaname--delete">DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}</a></td>
+ <td><p>delete an existing metadatum</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--service-instances-service-instance--service-instance-id--relationship-list-relationship-put">PUT /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--service-instances-service-instance--service-instance-id--relationship-list-relationship-delete">DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-lines-of-business-get">GET /business/lines-of-business</a></td>
+ <td><p>returns lines-of-business</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-lines-of-business-line-of-business--line-of-business-name--get">GET /business/lines-of-business/line-of-business/{line-of-business-name}</a></td>
+ <td><p>returns line-of-business</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-lines-of-business-line-of-business--line-of-business-name--put">PUT /business/lines-of-business/line-of-business/{line-of-business-name}</a></td>
+ <td><p>create or update an existing line-of-business</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-lines-of-business-line-of-business--line-of-business-name--patch">PATCH /business/lines-of-business/line-of-business/{line-of-business-name}</a></td>
+ <td><p>update an existing line-of-business</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-lines-of-business-line-of-business--line-of-business-name--delete">DELETE /business/lines-of-business/line-of-business/{line-of-business-name}</a></td>
+ <td><p>delete an existing line-of-business</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-lines-of-business-line-of-business--line-of-business-name--relationship-list-relationship-put">PUT /business/lines-of-business/line-of-business/{line-of-business-name}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-lines-of-business-line-of-business--line-of-business-name--relationship-list-relationship-delete">DELETE /business/lines-of-business/line-of-business/{line-of-business-name}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-owning-entities-get">GET /business/owning-entities</a></td>
+ <td><p>returns owning-entities</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-owning-entities-owning-entity--owning-entity-id--get">GET /business/owning-entities/owning-entity/{owning-entity-id}</a></td>
+ <td><p>returns owning-entity</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-owning-entities-owning-entity--owning-entity-id--put">PUT /business/owning-entities/owning-entity/{owning-entity-id}</a></td>
+ <td><p>create or update an existing owning-entity</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-owning-entities-owning-entity--owning-entity-id--patch">PATCH /business/owning-entities/owning-entity/{owning-entity-id}</a></td>
+ <td><p>update an existing owning-entity</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-owning-entities-owning-entity--owning-entity-id--delete">DELETE /business/owning-entities/owning-entity/{owning-entity-id}</a></td>
+ <td><p>delete an existing owning-entity</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-owning-entities-owning-entity--owning-entity-id--relationship-list-relationship-put">PUT /business/owning-entities/owning-entity/{owning-entity-id}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-owning-entities-owning-entity--owning-entity-id--relationship-list-relationship-delete">DELETE /business/owning-entities/owning-entity/{owning-entity-id}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-platforms-get">GET /business/platforms</a></td>
+ <td><p>returns platforms</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-platforms-platform--platform-name--get">GET /business/platforms/platform/{platform-name}</a></td>
+ <td><p>returns platform</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-platforms-platform--platform-name--put">PUT /business/platforms/platform/{platform-name}</a></td>
+ <td><p>create or update an existing platform</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-platforms-platform--platform-name--patch">PATCH /business/platforms/platform/{platform-name}</a></td>
+ <td><p>update an existing platform</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-platforms-platform--platform-name--delete">DELETE /business/platforms/platform/{platform-name}</a></td>
+ <td><p>delete an existing platform</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-platforms-platform--platform-name--relationship-list-relationship-put">PUT /business/platforms/platform/{platform-name}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-platforms-platform--platform-name--relationship-list-relationship-delete">DELETE /business/platforms/platform/{platform-name}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-projects-get">GET /business/projects</a></td>
+ <td><p>returns projects</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-projects-project--project-name--get">GET /business/projects/project/{project-name}</a></td>
+ <td><p>returns project</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-projects-project--project-name--put">PUT /business/projects/project/{project-name}</a></td>
+ <td><p>create or update an existing project</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-projects-project--project-name--patch">PATCH /business/projects/project/{project-name}</a></td>
+ <td><p>update an existing project</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-projects-project--project-name--delete">DELETE /business/projects/project/{project-name}</a></td>
+ <td><p>delete an existing project</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-projects-project--project-name--relationship-list-relationship-put">PUT /business/projects/project/{project-name}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--business-projects-project--project-name--relationship-list-relationship-delete">DELETE /business/projects/project/{project-name}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+
+ <h3 id="tag-ServiceDesignAndCreation" class="swagger-summary-tag">Tag: ServiceDesignAndCreation</h3>
+
+ <table class="table table-bordered table-condensed swagger--summary">
+ <thead>
+ <tr>
+ <th>Operation</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-models-get">GET /service-design-and-creation/models</a></td>
+ <td><p>returns models</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-models-model--model-invariant-id--get">GET /service-design-and-creation/models/model/{model-invariant-id}</a></td>
+ <td><p>returns model</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-models-model--model-invariant-id--put">PUT /service-design-and-creation/models/model/{model-invariant-id}</a></td>
+ <td><p>create or update an existing model</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-models-model--model-invariant-id--patch">PATCH /service-design-and-creation/models/model/{model-invariant-id}</a></td>
+ <td><p>update an existing model</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-models-model--model-invariant-id--delete">DELETE /service-design-and-creation/models/model/{model-invariant-id}</a></td>
+ <td><p>delete an existing model</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-models-model--model-invariant-id--model-vers-get">GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers</a></td>
+ <td><p>returns model-vers</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-models-model--model-invariant-id--model-vers-model-ver--model-version-id--get">GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}</a></td>
+ <td><p>returns model-ver</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-models-model--model-invariant-id--model-vers-model-ver--model-version-id--put">PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}</a></td>
+ <td><p>create or update an existing model-ver</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-models-model--model-invariant-id--model-vers-model-ver--model-version-id--patch">PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}</a></td>
+ <td><p>update an existing model-ver</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-models-model--model-invariant-id--model-vers-model-ver--model-version-id--delete">DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}</a></td>
+ <td><p>delete an existing model-ver</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-models-model--model-invariant-id--model-vers-model-ver--model-version-id--metadata-get">GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata</a></td>
+ <td><p>returns metadata</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-models-model--model-invariant-id--model-vers-model-ver--model-version-id--metadata-metadatum--metaname--get">GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}</a></td>
+ <td><p>returns metadatum</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-models-model--model-invariant-id--model-vers-model-ver--model-version-id--metadata-metadatum--metaname--put">PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}</a></td>
+ <td><p>create or update an existing metadatum</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-models-model--model-invariant-id--model-vers-model-ver--model-version-id--metadata-metadatum--metaname--patch">PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}</a></td>
+ <td><p>update an existing metadatum</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-models-model--model-invariant-id--model-vers-model-ver--model-version-id--metadata-metadatum--metaname--delete">DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}</a></td>
+ <td><p>delete an existing metadatum</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-models-model--model-invariant-id--model-vers-model-ver--model-version-id--model-elements-get">GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements</a></td>
+ <td><p>returns model-elements</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}</a></td>
+ <td><p>returns model-element</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}</a></td>
+ <td><p>create or update an existing model-element</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-models-model--model-invariant-id--model-vers-model-ver--model-version-id--model-elements-model-element--model-element-uuid--patch">PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}</a></td>
+ <td><p>update an existing model-element</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}</a></td>
+ <td><p>delete an existing model-element</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>returns model-constraints</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>returns model-constraint</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>create or update an existing model-constraint</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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--patch">PATCH /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}</a></td>
+ <td><p>update an existing model-constraint</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>delete an existing model-constraint</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>returns constrained-element-sets</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>returns constrained-element-set</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>create or update an existing constrained-element-set</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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--patch">PATCH /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}</a></td>
+ <td><p>update an existing constrained-element-set</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>delete an existing constrained-element-set</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>returns element-choice-sets</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>returns element-choice-set</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>create or update an existing element-choice-set</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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--patch">PATCH /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}</a></td>
+ <td><p>update an existing element-choice-set</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>delete an existing element-choice-set</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-models-model--model-invariant-id--model-vers-model-ver--model-version-id--relationship-list-relationship-put">PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-models-model--model-invariant-id--model-vers-model-ver--model-version-id--relationship-list-relationship-delete">DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-models-model--model-invariant-id--relationship-list-relationship-put">PUT /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-models-model--model-invariant-id--relationship-list-relationship-delete">DELETE /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-named-queries-get">GET /service-design-and-creation/named-queries</a></td>
+ <td><p>returns named-queries</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-named-queries-named-query--named-query-uuid--get">GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}</a></td>
+ <td><p>returns named-query</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-named-queries-named-query--named-query-uuid--put">PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}</a></td>
+ <td><p>create or update an existing named-query</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-named-queries-named-query--named-query-uuid--patch">PATCH /service-design-and-creation/named-queries/named-query/{named-query-uuid}</a></td>
+ <td><p>update an existing named-query</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-named-queries-named-query--named-query-uuid--delete">DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}</a></td>
+ <td><p>delete an existing named-query</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-named-queries-named-query--named-query-uuid--named-query-elements-get">GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements</a></td>
+ <td><p>returns named-query-elements</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-named-queries-named-query--named-query-uuid--named-query-elements-named-query-element--named-query-element-uuid--get">GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}</a></td>
+ <td><p>returns named-query-element</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-named-queries-named-query--named-query-uuid--named-query-elements-named-query-element--named-query-element-uuid--put">PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}</a></td>
+ <td><p>create or update an existing named-query-element</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-named-queries-named-query--named-query-uuid--named-query-elements-named-query-element--named-query-element-uuid--patch">PATCH /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}</a></td>
+ <td><p>update an existing named-query-element</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-named-queries-named-query--named-query-uuid--named-query-elements-named-query-element--named-query-element-uuid--delete">DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}</a></td>
+ <td><p>delete an existing named-query-element</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints</a></td>
+ <td><p>returns property-constraints</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>returns property-constraint</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>create or update an existing property-constraint</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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--patch">PATCH /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}</a></td>
+ <td><p>update an existing property-constraint</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>delete an existing property-constraint</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups</a></td>
+ <td><p>returns related-lookups</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>returns related-lookup</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>create or update an existing related-lookup</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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--patch">PATCH /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}</a></td>
+ <td><p>update an existing related-lookup</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>delete an existing related-lookup</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-named-queries-named-query--named-query-uuid--relationship-list-relationship-put">PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-named-queries-named-query--named-query-uuid--relationship-list-relationship-delete">DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-service-capabilities-get">GET /service-design-and-creation/service-capabilities</a></td>
+ <td><p>returns service-capabilities</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-service-capabilities-service-capability--service-type---vnf-type--get">GET /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}</a></td>
+ <td><p>returns service-capability</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-service-capabilities-service-capability--service-type---vnf-type--put">PUT /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}</a></td>
+ <td><p>create or update an existing service-capability</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-service-capabilities-service-capability--service-type---vnf-type--patch">PATCH /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}</a></td>
+ <td><p>update an existing service-capability</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-service-capabilities-service-capability--service-type---vnf-type--delete">DELETE /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}</a></td>
+ <td><p>delete an existing service-capability</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-service-capabilities-service-capability--service-type---vnf-type--relationship-list-relationship-put">PUT /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-service-capabilities-service-capability--service-type---vnf-type--relationship-list-relationship-delete">DELETE /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-services-get">GET /service-design-and-creation/services</a></td>
+ <td><p>returns services</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-services-service--service-id--get">GET /service-design-and-creation/services/service/{service-id}</a></td>
+ <td><p>returns service</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-services-service--service-id--put">PUT /service-design-and-creation/services/service/{service-id}</a></td>
+ <td><p>create or update an existing service</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-services-service--service-id--patch">PATCH /service-design-and-creation/services/service/{service-id}</a></td>
+ <td><p>update an existing service</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-services-service--service-id--delete">DELETE /service-design-and-creation/services/service/{service-id}</a></td>
+ <td><p>delete an existing service</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-services-service--service-id--relationship-list-relationship-put">PUT /service-design-and-creation/services/service/{service-id}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-services-service--service-id--relationship-list-relationship-delete">DELETE /service-design-and-creation/services/service/{service-id}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-vnf-images-get">GET /service-design-and-creation/vnf-images</a></td>
+ <td><p>returns vnf-images</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-vnf-images-vnf-image--vnf-image-uuid--get">GET /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}</a></td>
+ <td><p>returns vnf-image</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-vnf-images-vnf-image--vnf-image-uuid--put">PUT /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}</a></td>
+ <td><p>create or update an existing vnf-image</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-vnf-images-vnf-image--vnf-image-uuid--patch">PATCH /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}</a></td>
+ <td><p>update an existing vnf-image</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-vnf-images-vnf-image--vnf-image-uuid--delete">DELETE /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}</a></td>
+ <td><p>delete an existing vnf-image</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-vnf-images-vnf-image--vnf-image-uuid--relationship-list-relationship-put">PUT /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--service-design-and-creation-vnf-images-vnf-image--vnf-image-uuid--relationship-list-relationship-delete">DELETE /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+
+ <h3 id="tag-Network" class="swagger-summary-tag">Tag: Network</h3>
+
+ <table class="table table-bordered table-condensed swagger--summary">
+ <thead>
+ <tr>
+ <th>Operation</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><a href="#operation--network-configurations-get">GET /network/configurations</a></td>
+ <td><p>returns configurations</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-configurations-configuration--configuration-id--get">GET /network/configurations/configuration/{configuration-id}</a></td>
+ <td><p>returns configuration</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-configurations-configuration--configuration-id--put">PUT /network/configurations/configuration/{configuration-id}</a></td>
+ <td><p>create or update an existing configuration</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-configurations-configuration--configuration-id--patch">PATCH /network/configurations/configuration/{configuration-id}</a></td>
+ <td><p>update an existing configuration</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-configurations-configuration--configuration-id--delete">DELETE /network/configurations/configuration/{configuration-id}</a></td>
+ <td><p>delete an existing configuration</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-configurations-configuration--configuration-id--evcs-get">GET /network/configurations/configuration/{configuration-id}/evcs</a></td>
+ <td><p>returns evcs</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-configurations-configuration--configuration-id--evcs-evc--evc-id--get">GET /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}</a></td>
+ <td><p>returns evc</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-configurations-configuration--configuration-id--evcs-evc--evc-id--put">PUT /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}</a></td>
+ <td><p>create or update an existing evc</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-configurations-configuration--configuration-id--evcs-evc--evc-id--patch">PATCH /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}</a></td>
+ <td><p>update an existing evc</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-configurations-configuration--configuration-id--evcs-evc--evc-id--delete">DELETE /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}</a></td>
+ <td><p>delete an existing evc</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-configurations-configuration--configuration-id--evcs-evc--evc-id--relationship-list-relationship-put">PUT /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-configurations-configuration--configuration-id--evcs-evc--evc-id--relationship-list-relationship-delete">DELETE /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-configurations-configuration--configuration-id--forwarder-evcs-get">GET /network/configurations/configuration/{configuration-id}/forwarder-evcs</a></td>
+ <td><p>returns forwarder-evcs</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-configurations-configuration--configuration-id--forwarder-evcs-forwarder-evc--forwarder-evc-id--get">GET /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}</a></td>
+ <td><p>returns forwarder-evc</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-configurations-configuration--configuration-id--forwarder-evcs-forwarder-evc--forwarder-evc-id--put">PUT /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}</a></td>
+ <td><p>create or update an existing forwarder-evc</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-configurations-configuration--configuration-id--forwarder-evcs-forwarder-evc--forwarder-evc-id--patch">PATCH /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}</a></td>
+ <td><p>update an existing forwarder-evc</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-configurations-configuration--configuration-id--forwarder-evcs-forwarder-evc--forwarder-evc-id--delete">DELETE /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}</a></td>
+ <td><p>delete an existing forwarder-evc</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-configurations-configuration--configuration-id--forwarder-evcs-forwarder-evc--forwarder-evc-id--relationship-list-relationship-put">PUT /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-configurations-configuration--configuration-id--forwarder-evcs-forwarder-evc--forwarder-evc-id--relationship-list-relationship-delete">DELETE /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-configurations-configuration--configuration-id--metadata-get">GET /network/configurations/configuration/{configuration-id}/metadata</a></td>
+ <td><p>returns metadata</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-configurations-configuration--configuration-id--metadata-metadatum--metaname--get">GET /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}</a></td>
+ <td><p>returns metadatum</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-configurations-configuration--configuration-id--metadata-metadatum--metaname--put">PUT /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}</a></td>
+ <td><p>create or update an existing metadatum</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-configurations-configuration--configuration-id--metadata-metadatum--metaname--patch">PATCH /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}</a></td>
+ <td><p>update an existing metadatum</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-configurations-configuration--configuration-id--metadata-metadatum--metaname--delete">DELETE /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}</a></td>
+ <td><p>delete an existing metadatum</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-configurations-configuration--configuration-id--relationship-list-relationship-put">PUT /network/configurations/configuration/{configuration-id}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-configurations-configuration--configuration-id--relationship-list-relationship-delete">DELETE /network/configurations/configuration/{configuration-id}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-forwarding-paths-get">GET /network/forwarding-paths</a></td>
+ <td><p>returns forwarding-paths</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-forwarding-paths-forwarding-path--forwarding-path-id--get">GET /network/forwarding-paths/forwarding-path/{forwarding-path-id}</a></td>
+ <td><p>returns forwarding-path</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-forwarding-paths-forwarding-path--forwarding-path-id--put">PUT /network/forwarding-paths/forwarding-path/{forwarding-path-id}</a></td>
+ <td><p>create or update an existing forwarding-path</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-forwarding-paths-forwarding-path--forwarding-path-id--patch">PATCH /network/forwarding-paths/forwarding-path/{forwarding-path-id}</a></td>
+ <td><p>update an existing forwarding-path</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-forwarding-paths-forwarding-path--forwarding-path-id--delete">DELETE /network/forwarding-paths/forwarding-path/{forwarding-path-id}</a></td>
+ <td><p>delete an existing forwarding-path</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-forwarding-paths-forwarding-path--forwarding-path-id--forwarders-get">GET /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders</a></td>
+ <td><p>returns forwarders</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-forwarding-paths-forwarding-path--forwarding-path-id--forwarders-forwarder--sequence--get">GET /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}</a></td>
+ <td><p>returns forwarder</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-forwarding-paths-forwarding-path--forwarding-path-id--forwarders-forwarder--sequence--put">PUT /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}</a></td>
+ <td><p>create or update an existing forwarder</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-forwarding-paths-forwarding-path--forwarding-path-id--forwarders-forwarder--sequence--patch">PATCH /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}</a></td>
+ <td><p>update an existing forwarder</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-forwarding-paths-forwarding-path--forwarding-path-id--forwarders-forwarder--sequence--delete">DELETE /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}</a></td>
+ <td><p>delete an existing forwarder</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-forwarding-paths-forwarding-path--forwarding-path-id--forwarders-forwarder--sequence--relationship-list-relationship-put">PUT /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-forwarding-paths-forwarding-path--forwarding-path-id--forwarders-forwarder--sequence--relationship-list-relationship-delete">DELETE /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-forwarding-paths-forwarding-path--forwarding-path-id--relationship-list-relationship-put">PUT /network/forwarding-paths/forwarding-path/{forwarding-path-id}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-forwarding-paths-forwarding-path--forwarding-path-id--relationship-list-relationship-delete">DELETE /network/forwarding-paths/forwarding-path/{forwarding-path-id}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-get">GET /network/generic-vnfs</a></td>
+ <td><p>returns generic-vnfs</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--get">GET /network/generic-vnfs/generic-vnf/{vnf-id}</a></td>
+ <td><p>returns generic-vnf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--put">PUT /network/generic-vnfs/generic-vnf/{vnf-id}</a></td>
+ <td><p>create or update an existing generic-vnf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--patch">PATCH /network/generic-vnfs/generic-vnf/{vnf-id}</a></td>
+ <td><p>update an existing generic-vnf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--delete">DELETE /network/generic-vnfs/generic-vnf/{vnf-id}</a></td>
+ <td><p>delete an existing generic-vnf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--entitlements-get">GET /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements</a></td>
+ <td><p>returns entitlements</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--entitlements-entitlement--group-uuid---resource-uuid--get">GET /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}</a></td>
+ <td><p>returns entitlement</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--entitlements-entitlement--group-uuid---resource-uuid--put">PUT /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}</a></td>
+ <td><p>create or update an existing entitlement</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--entitlements-entitlement--group-uuid---resource-uuid--patch">PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}</a></td>
+ <td><p>update an existing entitlement</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--entitlements-entitlement--group-uuid---resource-uuid--delete">DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}</a></td>
+ <td><p>delete an existing entitlement</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--entitlements-entitlement--group-uuid---resource-uuid--relationship-list-relationship-put">PUT /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--entitlements-entitlement--group-uuid---resource-uuid--relationship-list-relationship-delete">DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-get">GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces</a></td>
+ <td><p>returns l-interfaces</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--get">GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}</a></td>
+ <td><p>returns l-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--put">PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}</a></td>
+ <td><p>create or update an existing l-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--patch">PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}</a></td>
+ <td><p>update an existing l-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--delete">DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}</a></td>
+ <td><p>delete an existing l-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--l3-interface-ipv4-address-list--l3-interface-ipv4-address--get">GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}</a></td>
+ <td><p>returns l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--l3-interface-ipv4-address-list--l3-interface-ipv4-address--put">PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}</a></td>
+ <td><p>create or update an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--l3-interface-ipv4-address-list--l3-interface-ipv4-address--patch">PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}</a></td>
+ <td><p>update an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--l3-interface-ipv4-address-list--l3-interface-ipv4-address--delete">DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}</a></td>
+ <td><p>delete an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--l3-interface-ipv6-address-list--l3-interface-ipv6-address--get">GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}</a></td>
+ <td><p>returns l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--l3-interface-ipv6-address-list--l3-interface-ipv6-address--put">PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}</a></td>
+ <td><p>create or update an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--l3-interface-ipv6-address-list--l3-interface-ipv6-address--patch">PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}</a></td>
+ <td><p>update an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--l3-interface-ipv6-address-list--l3-interface-ipv6-address--delete">DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}</a></td>
+ <td><p>delete an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--relationship-list-relationship-put">PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--relationship-list-relationship-delete">DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--sriov-vfs-get">GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs</a></td>
+ <td><p>returns sriov-vfs</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--get">GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}</a></td>
+ <td><p>returns sriov-vf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--put">PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}</a></td>
+ <td><p>create or update an existing sriov-vf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--patch">PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}</a></td>
+ <td><p>update an existing sriov-vf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--delete">DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}</a></td>
+ <td><p>delete an existing sriov-vf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--relationship-list-relationship-put">PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--relationship-list-relationship-delete">DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--vlans-get">GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans</a></td>
+ <td><p>returns vlans</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--get">GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</a></td>
+ <td><p>returns vlan</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--put">PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</a></td>
+ <td><p>create or update an existing vlan</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--patch">PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</a></td>
+ <td><p>update an existing vlan</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--delete">DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</a></td>
+ <td><p>delete an existing vlan</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>returns l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>create or update an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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--patch">PATCH /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}</a></td>
+ <td><p>update an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>delete an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>returns l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>create or update an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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--patch">PATCH /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}</a></td>
+ <td><p>update an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>delete an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--relationship-list-relationship-put">PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--relationship-list-relationship-delete">DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-get">GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces</a></td>
+ <td><p>returns lag-interfaces</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--get">GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}</a></td>
+ <td><p>returns lag-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--put">PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}</a></td>
+ <td><p>create or update an existing lag-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--patch">PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}</a></td>
+ <td><p>update an existing lag-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--delete">DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}</a></td>
+ <td><p>delete an existing lag-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--l-interfaces-get">GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces</a></td>
+ <td><p>returns l-interfaces</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--get">GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</a></td>
+ <td><p>returns l-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--put">PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</a></td>
+ <td><p>create or update an existing l-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--patch">PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</a></td>
+ <td><p>update an existing l-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--delete">DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</a></td>
+ <td><p>delete an existing l-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>returns l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>create or update an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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--patch">PATCH /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}</a></td>
+ <td><p>update an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>delete an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>returns l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>create or update an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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--patch">PATCH /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}</a></td>
+ <td><p>update an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>delete an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--relationship-list-relationship-put">PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--relationship-list-relationship-delete">DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-get">GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs</a></td>
+ <td><p>returns sriov-vfs</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>returns sriov-vf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>create or update an existing sriov-vf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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--patch">PATCH /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}</a></td>
+ <td><p>update an existing sriov-vf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>delete an existing sriov-vf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-get">GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans</a></td>
+ <td><p>returns vlans</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</a></td>
+ <td><p>returns vlan</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</a></td>
+ <td><p>create or update an existing vlan</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--patch">PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</a></td>
+ <td><p>update an existing vlan</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</a></td>
+ <td><p>delete an existing vlan</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>returns l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>create or update an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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--patch">PATCH /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}</a></td>
+ <td><p>update an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>delete an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>returns l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>create or update an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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--patch">PATCH /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}</a></td>
+ <td><p>update an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>delete an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--relationship-list-relationship-put">PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--relationship-list-relationship-delete">DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--licenses-get">GET /network/generic-vnfs/generic-vnf/{vnf-id}/licenses</a></td>
+ <td><p>returns licenses</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--licenses-license--group-uuid---resource-uuid--get">GET /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}</a></td>
+ <td><p>returns license</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--licenses-license--group-uuid---resource-uuid--put">PUT /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}</a></td>
+ <td><p>create or update an existing license</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--licenses-license--group-uuid---resource-uuid--patch">PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}</a></td>
+ <td><p>update an existing license</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--licenses-license--group-uuid---resource-uuid--delete">DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}</a></td>
+ <td><p>delete an existing license</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--licenses-license--group-uuid---resource-uuid--relationship-list-relationship-put">PUT /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--licenses-license--group-uuid---resource-uuid--relationship-list-relationship-delete">DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--relationship-list-relationship-put">PUT /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--relationship-list-relationship-delete">DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--vf-modules-get">GET /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules</a></td>
+ <td><p>returns vf-modules</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--vf-modules-vf-module--vf-module-id--get">GET /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}</a></td>
+ <td><p>returns vf-module</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--vf-modules-vf-module--vf-module-id--put">PUT /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}</a></td>
+ <td><p>create or update an existing vf-module</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--vf-modules-vf-module--vf-module-id--patch">PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}</a></td>
+ <td><p>update an existing vf-module</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--vf-modules-vf-module--vf-module-id--delete">DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}</a></td>
+ <td><p>delete an existing vf-module</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--vf-modules-vf-module--vf-module-id--relationship-list-relationship-put">PUT /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-generic-vnfs-generic-vnf--vnf-id--vf-modules-vf-module--vf-module-id--relationship-list-relationship-delete">DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-instance-groups-get">GET /network/instance-groups</a></td>
+ <td><p>returns instance-groups</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-instance-groups-instance-group--id--get">GET /network/instance-groups/instance-group/{id}</a></td>
+ <td><p>returns instance-group</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-instance-groups-instance-group--id--put">PUT /network/instance-groups/instance-group/{id}</a></td>
+ <td><p>create or update an existing instance-group</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-instance-groups-instance-group--id--patch">PATCH /network/instance-groups/instance-group/{id}</a></td>
+ <td><p>update an existing instance-group</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-instance-groups-instance-group--id--delete">DELETE /network/instance-groups/instance-group/{id}</a></td>
+ <td><p>delete an existing instance-group</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-instance-groups-instance-group--id--relationship-list-relationship-put">PUT /network/instance-groups/instance-group/{id}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-instance-groups-instance-group--id--relationship-list-relationship-delete">DELETE /network/instance-groups/instance-group/{id}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-ipsec-configurations-get">GET /network/ipsec-configurations</a></td>
+ <td><p>returns ipsec-configurations</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-ipsec-configurations-ipsec-configuration--ipsec-configuration-id--get">GET /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}</a></td>
+ <td><p>returns ipsec-configuration</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-ipsec-configurations-ipsec-configuration--ipsec-configuration-id--put">PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}</a></td>
+ <td><p>create or update an existing ipsec-configuration</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-ipsec-configurations-ipsec-configuration--ipsec-configuration-id--patch">PATCH /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}</a></td>
+ <td><p>update an existing ipsec-configuration</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-ipsec-configurations-ipsec-configuration--ipsec-configuration-id--delete">DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}</a></td>
+ <td><p>delete an existing ipsec-configuration</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-ipsec-configurations-ipsec-configuration--ipsec-configuration-id--relationship-list-relationship-put">PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-ipsec-configurations-ipsec-configuration--ipsec-configuration-id--relationship-list-relationship-delete">DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-ipsec-configurations-ipsec-configuration--ipsec-configuration-id--vig-servers-get">GET /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers</a></td>
+ <td><p>returns vig-servers</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-ipsec-configurations-ipsec-configuration--ipsec-configuration-id--vig-servers-vig-server--vig-address-type--get">GET /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}</a></td>
+ <td><p>returns vig-server</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-ipsec-configurations-ipsec-configuration--ipsec-configuration-id--vig-servers-vig-server--vig-address-type--put">PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}</a></td>
+ <td><p>create or update an existing vig-server</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-ipsec-configurations-ipsec-configuration--ipsec-configuration-id--vig-servers-vig-server--vig-address-type--patch">PATCH /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}</a></td>
+ <td><p>update an existing vig-server</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-ipsec-configurations-ipsec-configuration--ipsec-configuration-id--vig-servers-vig-server--vig-address-type--delete">DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}</a></td>
+ <td><p>delete an existing vig-server</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-ipsec-configurations-ipsec-configuration--ipsec-configuration-id--vig-servers-vig-server--vig-address-type--relationship-list-relationship-put">PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-ipsec-configurations-ipsec-configuration--ipsec-configuration-id--vig-servers-vig-server--vig-address-type--relationship-list-relationship-delete">DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-l3-networks-get">GET /network/l3-networks</a></td>
+ <td><p>returns l3-networks</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-l3-networks-l3-network--network-id--get">GET /network/l3-networks/l3-network/{network-id}</a></td>
+ <td><p>returns l3-network</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-l3-networks-l3-network--network-id--put">PUT /network/l3-networks/l3-network/{network-id}</a></td>
+ <td><p>create or update an existing l3-network</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-l3-networks-l3-network--network-id--patch">PATCH /network/l3-networks/l3-network/{network-id}</a></td>
+ <td><p>update an existing l3-network</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-l3-networks-l3-network--network-id--delete">DELETE /network/l3-networks/l3-network/{network-id}</a></td>
+ <td><p>delete an existing l3-network</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-l3-networks-l3-network--network-id--ctag-assignments-get">GET /network/l3-networks/l3-network/{network-id}/ctag-assignments</a></td>
+ <td><p>returns ctag-assignments</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-l3-networks-l3-network--network-id--ctag-assignments-ctag-assignment--vlan-id-inner--get">GET /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}</a></td>
+ <td><p>returns ctag-assignment</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-l3-networks-l3-network--network-id--ctag-assignments-ctag-assignment--vlan-id-inner--put">PUT /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}</a></td>
+ <td><p>create or update an existing ctag-assignment</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-l3-networks-l3-network--network-id--ctag-assignments-ctag-assignment--vlan-id-inner--patch">PATCH /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}</a></td>
+ <td><p>update an existing ctag-assignment</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-l3-networks-l3-network--network-id--ctag-assignments-ctag-assignment--vlan-id-inner--delete">DELETE /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}</a></td>
+ <td><p>delete an existing ctag-assignment</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-l3-networks-l3-network--network-id--ctag-assignments-ctag-assignment--vlan-id-inner--relationship-list-relationship-put">PUT /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-l3-networks-l3-network--network-id--ctag-assignments-ctag-assignment--vlan-id-inner--relationship-list-relationship-delete">DELETE /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-l3-networks-l3-network--network-id--relationship-list-relationship-put">PUT /network/l3-networks/l3-network/{network-id}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-l3-networks-l3-network--network-id--relationship-list-relationship-delete">DELETE /network/l3-networks/l3-network/{network-id}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-l3-networks-l3-network--network-id--segmentation-assignments-get">GET /network/l3-networks/l3-network/{network-id}/segmentation-assignments</a></td>
+ <td><p>returns segmentation-assignments</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-l3-networks-l3-network--network-id--segmentation-assignments-segmentation-assignment--segmentation-id--get">GET /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}</a></td>
+ <td><p>returns segmentation-assignment</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-l3-networks-l3-network--network-id--segmentation-assignments-segmentation-assignment--segmentation-id--put">PUT /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}</a></td>
+ <td><p>create or update an existing segmentation-assignment</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-l3-networks-l3-network--network-id--segmentation-assignments-segmentation-assignment--segmentation-id--patch">PATCH /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}</a></td>
+ <td><p>update an existing segmentation-assignment</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-l3-networks-l3-network--network-id--segmentation-assignments-segmentation-assignment--segmentation-id--delete">DELETE /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}</a></td>
+ <td><p>delete an existing segmentation-assignment</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-l3-networks-l3-network--network-id--segmentation-assignments-segmentation-assignment--segmentation-id--relationship-list-relationship-put">PUT /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-l3-networks-l3-network--network-id--segmentation-assignments-segmentation-assignment--segmentation-id--relationship-list-relationship-delete">DELETE /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-l3-networks-l3-network--network-id--subnets-get">GET /network/l3-networks/l3-network/{network-id}/subnets</a></td>
+ <td><p>returns subnets</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-l3-networks-l3-network--network-id--subnets-subnet--subnet-id--get">GET /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}</a></td>
+ <td><p>returns subnet</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-l3-networks-l3-network--network-id--subnets-subnet--subnet-id--put">PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}</a></td>
+ <td><p>create or update an existing subnet</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-l3-networks-l3-network--network-id--subnets-subnet--subnet-id--patch">PATCH /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}</a></td>
+ <td><p>update an existing subnet</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-l3-networks-l3-network--network-id--subnets-subnet--subnet-id--delete">DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}</a></td>
+ <td><p>delete an existing subnet</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-l3-networks-l3-network--network-id--subnets-subnet--subnet-id--host-routes-get">GET /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes</a></td>
+ <td><p>returns host-routes</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-l3-networks-l3-network--network-id--subnets-subnet--subnet-id--host-routes-host-route--host-route-id--get">GET /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}</a></td>
+ <td><p>returns host-route</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-l3-networks-l3-network--network-id--subnets-subnet--subnet-id--host-routes-host-route--host-route-id--put">PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}</a></td>
+ <td><p>create or update an existing host-route</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-l3-networks-l3-network--network-id--subnets-subnet--subnet-id--host-routes-host-route--host-route-id--patch">PATCH /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}</a></td>
+ <td><p>update an existing host-route</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-l3-networks-l3-network--network-id--subnets-subnet--subnet-id--host-routes-host-route--host-route-id--delete">DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}</a></td>
+ <td><p>delete an existing host-route</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-l3-networks-l3-network--network-id--subnets-subnet--subnet-id--host-routes-host-route--host-route-id--relationship-list-relationship-put">PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-l3-networks-l3-network--network-id--subnets-subnet--subnet-id--host-routes-host-route--host-route-id--relationship-list-relationship-delete">DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-l3-networks-l3-network--network-id--subnets-subnet--subnet-id--relationship-list-relationship-put">PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-l3-networks-l3-network--network-id--subnets-subnet--subnet-id--relationship-list-relationship-delete">DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-lag-links-get">GET /network/lag-links</a></td>
+ <td><p>returns lag-links</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-lag-links-lag-link--link-name--get">GET /network/lag-links/lag-link/{link-name}</a></td>
+ <td><p>returns lag-link</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-lag-links-lag-link--link-name--put">PUT /network/lag-links/lag-link/{link-name}</a></td>
+ <td><p>create or update an existing lag-link</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-lag-links-lag-link--link-name--patch">PATCH /network/lag-links/lag-link/{link-name}</a></td>
+ <td><p>update an existing lag-link</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-lag-links-lag-link--link-name--delete">DELETE /network/lag-links/lag-link/{link-name}</a></td>
+ <td><p>delete an existing lag-link</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-lag-links-lag-link--link-name--relationship-list-relationship-put">PUT /network/lag-links/lag-link/{link-name}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-lag-links-lag-link--link-name--relationship-list-relationship-delete">DELETE /network/lag-links/lag-link/{link-name}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-logical-links-get">GET /network/logical-links</a></td>
+ <td><p>returns logical-links</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-logical-links-logical-link--link-name--get">GET /network/logical-links/logical-link/{link-name}</a></td>
+ <td><p>returns logical-link</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-logical-links-logical-link--link-name--put">PUT /network/logical-links/logical-link/{link-name}</a></td>
+ <td><p>create or update an existing logical-link</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-logical-links-logical-link--link-name--patch">PATCH /network/logical-links/logical-link/{link-name}</a></td>
+ <td><p>update an existing logical-link</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-logical-links-logical-link--link-name--delete">DELETE /network/logical-links/logical-link/{link-name}</a></td>
+ <td><p>delete an existing logical-link</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-logical-links-logical-link--link-name--relationship-list-relationship-put">PUT /network/logical-links/logical-link/{link-name}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-logical-links-logical-link--link-name--relationship-list-relationship-delete">DELETE /network/logical-links/logical-link/{link-name}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-multicast-configurations-get">GET /network/multicast-configurations</a></td>
+ <td><p>returns multicast-configurations</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-multicast-configurations-multicast-configuration--multicast-configuration-id--get">GET /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}</a></td>
+ <td><p>returns multicast-configuration</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-multicast-configurations-multicast-configuration--multicast-configuration-id--put">PUT /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}</a></td>
+ <td><p>create or update an existing multicast-configuration</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-multicast-configurations-multicast-configuration--multicast-configuration-id--patch">PATCH /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}</a></td>
+ <td><p>update an existing multicast-configuration</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-multicast-configurations-multicast-configuration--multicast-configuration-id--delete">DELETE /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}</a></td>
+ <td><p>delete an existing multicast-configuration</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-multicast-configurations-multicast-configuration--multicast-configuration-id--relationship-list-relationship-put">PUT /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-multicast-configurations-multicast-configuration--multicast-configuration-id--relationship-list-relationship-delete">DELETE /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-network-policies-get">GET /network/network-policies</a></td>
+ <td><p>returns network-policies</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-network-policies-network-policy--network-policy-id--get">GET /network/network-policies/network-policy/{network-policy-id}</a></td>
+ <td><p>returns network-policy</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-network-policies-network-policy--network-policy-id--put">PUT /network/network-policies/network-policy/{network-policy-id}</a></td>
+ <td><p>create or update an existing network-policy</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-network-policies-network-policy--network-policy-id--patch">PATCH /network/network-policies/network-policy/{network-policy-id}</a></td>
+ <td><p>update an existing network-policy</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-network-policies-network-policy--network-policy-id--delete">DELETE /network/network-policies/network-policy/{network-policy-id}</a></td>
+ <td><p>delete an existing network-policy</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-network-policies-network-policy--network-policy-id--relationship-list-relationship-put">PUT /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-network-policies-network-policy--network-policy-id--relationship-list-relationship-delete">DELETE /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-newvces-get">GET /network/newvces</a></td>
+ <td><p>returns newvces</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-newvces-newvce--vnf-id2--get">GET /network/newvces/newvce/{vnf-id2}</a></td>
+ <td><p>returns newvce</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-newvces-newvce--vnf-id2--put">PUT /network/newvces/newvce/{vnf-id2}</a></td>
+ <td><p>create or update an existing newvce</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-newvces-newvce--vnf-id2--patch">PATCH /network/newvces/newvce/{vnf-id2}</a></td>
+ <td><p>update an existing newvce</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-newvces-newvce--vnf-id2--delete">DELETE /network/newvces/newvce/{vnf-id2}</a></td>
+ <td><p>delete an existing newvce</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-newvces-newvce--vnf-id2--l-interfaces-get">GET /network/newvces/newvce/{vnf-id2}/l-interfaces</a></td>
+ <td><p>returns l-interfaces</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--get">GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}</a></td>
+ <td><p>returns l-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--put">PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}</a></td>
+ <td><p>create or update an existing l-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--patch">PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}</a></td>
+ <td><p>update an existing l-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--delete">DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}</a></td>
+ <td><p>delete an existing l-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--l3-interface-ipv4-address-list--l3-interface-ipv4-address--get">GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}</a></td>
+ <td><p>returns l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--l3-interface-ipv4-address-list--l3-interface-ipv4-address--put">PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}</a></td>
+ <td><p>create or update an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--l3-interface-ipv4-address-list--l3-interface-ipv4-address--patch">PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}</a></td>
+ <td><p>update an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--l3-interface-ipv4-address-list--l3-interface-ipv4-address--delete">DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}</a></td>
+ <td><p>delete an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--l3-interface-ipv6-address-list--l3-interface-ipv6-address--get">GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}</a></td>
+ <td><p>returns l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--l3-interface-ipv6-address-list--l3-interface-ipv6-address--put">PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}</a></td>
+ <td><p>create or update an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--l3-interface-ipv6-address-list--l3-interface-ipv6-address--patch">PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}</a></td>
+ <td><p>update an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--l3-interface-ipv6-address-list--l3-interface-ipv6-address--delete">DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}</a></td>
+ <td><p>delete an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--relationship-list-relationship-put">PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--relationship-list-relationship-delete">DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--sriov-vfs-get">GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs</a></td>
+ <td><p>returns sriov-vfs</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--get">GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}</a></td>
+ <td><p>returns sriov-vf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--put">PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}</a></td>
+ <td><p>create or update an existing sriov-vf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--patch">PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}</a></td>
+ <td><p>update an existing sriov-vf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--delete">DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}</a></td>
+ <td><p>delete an existing sriov-vf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--relationship-list-relationship-put">PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--relationship-list-relationship-delete">DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--vlans-get">GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans</a></td>
+ <td><p>returns vlans</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--get">GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</a></td>
+ <td><p>returns vlan</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--put">PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</a></td>
+ <td><p>create or update an existing vlan</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--patch">PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</a></td>
+ <td><p>update an existing vlan</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--delete">DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</a></td>
+ <td><p>delete an existing vlan</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>returns l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>create or update an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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--patch">PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}</a></td>
+ <td><p>update an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>delete an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>returns l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>create or update an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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--patch">PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}</a></td>
+ <td><p>update an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>delete an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--relationship-list-relationship-put">PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--relationship-list-relationship-delete">DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-newvces-newvce--vnf-id2--relationship-list-relationship-put">PUT /network/newvces/newvce/{vnf-id2}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-newvces-newvce--vnf-id2--relationship-list-relationship-delete">DELETE /network/newvces/newvce/{vnf-id2}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-physical-links-get">GET /network/physical-links</a></td>
+ <td><p>returns physical-links</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-physical-links-physical-link--link-name--get">GET /network/physical-links/physical-link/{link-name}</a></td>
+ <td><p>returns physical-link</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-physical-links-physical-link--link-name--put">PUT /network/physical-links/physical-link/{link-name}</a></td>
+ <td><p>create or update an existing physical-link</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-physical-links-physical-link--link-name--patch">PATCH /network/physical-links/physical-link/{link-name}</a></td>
+ <td><p>update an existing physical-link</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-physical-links-physical-link--link-name--delete">DELETE /network/physical-links/physical-link/{link-name}</a></td>
+ <td><p>delete an existing physical-link</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-physical-links-physical-link--link-name--relationship-list-relationship-put">PUT /network/physical-links/physical-link/{link-name}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-physical-links-physical-link--link-name--relationship-list-relationship-delete">DELETE /network/physical-links/physical-link/{link-name}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-get">GET /network/pnfs</a></td>
+ <td><p>returns pnfs</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--get">GET /network/pnfs/pnf/{pnf-name}</a></td>
+ <td><p>returns pnf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--put">PUT /network/pnfs/pnf/{pnf-name}</a></td>
+ <td><p>create or update an existing pnf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--patch">PATCH /network/pnfs/pnf/{pnf-name}</a></td>
+ <td><p>update an existing pnf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--delete">DELETE /network/pnfs/pnf/{pnf-name}</a></td>
+ <td><p>delete an existing pnf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--lag-interfaces-get">GET /network/pnfs/pnf/{pnf-name}/lag-interfaces</a></td>
+ <td><p>returns lag-interfaces</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--get">GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}</a></td>
+ <td><p>returns lag-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--put">PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}</a></td>
+ <td><p>create or update an existing lag-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--patch">PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}</a></td>
+ <td><p>update an existing lag-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--delete">DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}</a></td>
+ <td><p>delete an existing lag-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-get">GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces</a></td>
+ <td><p>returns l-interfaces</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--get">GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</a></td>
+ <td><p>returns l-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--put">PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</a></td>
+ <td><p>create or update an existing l-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--patch">PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</a></td>
+ <td><p>update an existing l-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--delete">DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</a></td>
+ <td><p>delete an existing l-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>returns l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>create or update an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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--patch">PATCH /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}</a></td>
+ <td><p>update an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>delete an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>returns l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>create or update an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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--patch">PATCH /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}</a></td>
+ <td><p>update an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>delete an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--relationship-list-relationship-put">PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--relationship-list-relationship-delete">DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-get">GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs</a></td>
+ <td><p>returns sriov-vfs</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}</a></td>
+ <td><p>returns sriov-vf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}</a></td>
+ <td><p>create or update an existing sriov-vf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--patch">PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}</a></td>
+ <td><p>update an existing sriov-vf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}</a></td>
+ <td><p>delete an existing sriov-vf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-get">GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans</a></td>
+ <td><p>returns vlans</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--get">GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</a></td>
+ <td><p>returns vlan</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--put">PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</a></td>
+ <td><p>create or update an existing vlan</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--patch">PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</a></td>
+ <td><p>update an existing vlan</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--delete">DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</a></td>
+ <td><p>delete an existing vlan</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>returns l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>create or update an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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--patch">PATCH /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}</a></td>
+ <td><p>update an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>delete an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>returns l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>create or update an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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--patch">PATCH /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}</a></td>
+ <td><p>update an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>delete an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--relationship-list-relationship-put">PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--relationship-list-relationship-delete">DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--p-interfaces-get">GET /network/pnfs/pnf/{pnf-name}/p-interfaces</a></td>
+ <td><p>returns p-interfaces</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--get">GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}</a></td>
+ <td><p>returns p-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--put">PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}</a></td>
+ <td><p>create or update an existing p-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--patch">PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}</a></td>
+ <td><p>update an existing p-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--delete">DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}</a></td>
+ <td><p>delete an existing p-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-get">GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces</a></td>
+ <td><p>returns l-interfaces</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--get">GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</a></td>
+ <td><p>returns l-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--put">PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</a></td>
+ <td><p>create or update an existing l-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--patch">PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</a></td>
+ <td><p>update an existing l-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--delete">DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</a></td>
+ <td><p>delete an existing l-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>returns l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>create or update an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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--patch">PATCH /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}</a></td>
+ <td><p>update an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>delete an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>returns l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>create or update an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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--patch">PATCH /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}</a></td>
+ <td><p>update an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>delete an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--relationship-list-relationship-put">PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--relationship-list-relationship-delete">DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-get">GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs</a></td>
+ <td><p>returns sriov-vfs</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}</a></td>
+ <td><p>returns sriov-vf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}</a></td>
+ <td><p>create or update an existing sriov-vf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--patch">PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}</a></td>
+ <td><p>update an existing sriov-vf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}</a></td>
+ <td><p>delete an existing sriov-vf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-get">GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans</a></td>
+ <td><p>returns vlans</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--get">GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</a></td>
+ <td><p>returns vlan</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--put">PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</a></td>
+ <td><p>create or update an existing vlan</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--patch">PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</a></td>
+ <td><p>update an existing vlan</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--delete">DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</a></td>
+ <td><p>delete an existing vlan</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>returns l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>create or update an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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--patch">PATCH /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}</a></td>
+ <td><p>update an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>delete an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>returns l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>create or update an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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--patch">PATCH /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}</a></td>
+ <td><p>update an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>delete an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--relationship-list-relationship-put">PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--relationship-list-relationship-delete">DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--sriov-pfs-get">GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs</a></td>
+ <td><p>returns sriov-pfs</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--get">GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}</a></td>
+ <td><p>returns sriov-pf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--put">PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}</a></td>
+ <td><p>create or update an existing sriov-pf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--patch">PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}</a></td>
+ <td><p>update an existing sriov-pf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--delete">DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}</a></td>
+ <td><p>delete an existing sriov-pf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--relationship-list-relationship-put">PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--relationship-list-relationship-delete">DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--relationship-list-relationship-put">PUT /network/pnfs/pnf/{pnf-name}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-pnfs-pnf--pnf-name--relationship-list-relationship-delete">DELETE /network/pnfs/pnf/{pnf-name}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-route-table-references-get">GET /network/route-table-references</a></td>
+ <td><p>returns route-table-references</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-route-table-references-route-table-reference--route-table-reference-id--get">GET /network/route-table-references/route-table-reference/{route-table-reference-id}</a></td>
+ <td><p>returns route-table-reference</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-route-table-references-route-table-reference--route-table-reference-id--put">PUT /network/route-table-references/route-table-reference/{route-table-reference-id}</a></td>
+ <td><p>create or update an existing route-table-reference</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-route-table-references-route-table-reference--route-table-reference-id--patch">PATCH /network/route-table-references/route-table-reference/{route-table-reference-id}</a></td>
+ <td><p>update an existing route-table-reference</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-route-table-references-route-table-reference--route-table-reference-id--delete">DELETE /network/route-table-references/route-table-reference/{route-table-reference-id}</a></td>
+ <td><p>delete an existing route-table-reference</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-route-table-references-route-table-reference--route-table-reference-id--relationship-list-relationship-put">PUT /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-route-table-references-route-table-reference--route-table-reference-id--relationship-list-relationship-delete">DELETE /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-site-pair-sets-get">GET /network/site-pair-sets</a></td>
+ <td><p>returns site-pair-sets</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-site-pair-sets-site-pair-set--site-pair-set-id--get">GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}</a></td>
+ <td><p>returns site-pair-set</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-site-pair-sets-site-pair-set--site-pair-set-id--put">PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}</a></td>
+ <td><p>create or update an existing site-pair-set</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-site-pair-sets-site-pair-set--site-pair-set-id--patch">PATCH /network/site-pair-sets/site-pair-set/{site-pair-set-id}</a></td>
+ <td><p>update an existing site-pair-set</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-site-pair-sets-site-pair-set--site-pair-set-id--delete">DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}</a></td>
+ <td><p>delete an existing site-pair-set</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-site-pair-sets-site-pair-set--site-pair-set-id--relationship-list-relationship-put">PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-site-pair-sets-site-pair-set--site-pair-set-id--relationship-list-relationship-delete">DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-site-pair-sets-site-pair-set--site-pair-set-id--routing-instances-get">GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances</a></td>
+ <td><p>returns routing-instances</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-site-pair-sets-site-pair-set--site-pair-set-id--routing-instances-routing-instance--routing-instance-id--get">GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}</a></td>
+ <td><p>returns routing-instance</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-site-pair-sets-site-pair-set--site-pair-set-id--routing-instances-routing-instance--routing-instance-id--put">PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}</a></td>
+ <td><p>create or update an existing routing-instance</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-site-pair-sets-site-pair-set--site-pair-set-id--routing-instances-routing-instance--routing-instance-id--patch">PATCH /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}</a></td>
+ <td><p>update an existing routing-instance</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-site-pair-sets-site-pair-set--site-pair-set-id--routing-instances-routing-instance--routing-instance-id--delete">DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}</a></td>
+ <td><p>delete an existing routing-instance</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-site-pair-sets-site-pair-set--site-pair-set-id--routing-instances-routing-instance--routing-instance-id--relationship-list-relationship-put">PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-site-pair-sets-site-pair-set--site-pair-set-id--routing-instances-routing-instance--routing-instance-id--relationship-list-relationship-delete">DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-site-pair-sets-site-pair-set--site-pair-set-id--routing-instances-routing-instance--routing-instance-id--site-pairs-get">GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs</a></td>
+ <td><p>returns site-pairs</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>returns site-pair</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>create or update an existing site-pair</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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--patch">PATCH /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}</a></td>
+ <td><p>update an existing site-pair</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>delete an existing site-pair</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>returns classes-of-service</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>returns class-of-service</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>create or update an existing class-of-service</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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--patch">PATCH /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}</a></td>
+ <td><p>update an existing class-of-service</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>delete an existing class-of-service</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vces-get">GET /network/vces</a></td>
+ <td><p>returns vces</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vces-vce--vnf-id--get">GET /network/vces/vce/{vnf-id}</a></td>
+ <td><p>returns vce</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vces-vce--vnf-id--put">PUT /network/vces/vce/{vnf-id}</a></td>
+ <td><p>create or update an existing vce</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vces-vce--vnf-id--patch">PATCH /network/vces/vce/{vnf-id}</a></td>
+ <td><p>update an existing vce</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vces-vce--vnf-id--delete">DELETE /network/vces/vce/{vnf-id}</a></td>
+ <td><p>delete an existing vce</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vces-vce--vnf-id--entitlements-get">GET /network/vces/vce/{vnf-id}/entitlements</a></td>
+ <td><p>returns entitlements</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vces-vce--vnf-id--entitlements-entitlement--group-uuid---resource-uuid--get">GET /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}</a></td>
+ <td><p>returns entitlement</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vces-vce--vnf-id--entitlements-entitlement--group-uuid---resource-uuid--put">PUT /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}</a></td>
+ <td><p>create or update an existing entitlement</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vces-vce--vnf-id--entitlements-entitlement--group-uuid---resource-uuid--patch">PATCH /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}</a></td>
+ <td><p>update an existing entitlement</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vces-vce--vnf-id--entitlements-entitlement--group-uuid---resource-uuid--delete">DELETE /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}</a></td>
+ <td><p>delete an existing entitlement</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vces-vce--vnf-id--entitlements-entitlement--group-uuid---resource-uuid--relationship-list-relationship-put">PUT /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vces-vce--vnf-id--entitlements-entitlement--group-uuid---resource-uuid--relationship-list-relationship-delete">DELETE /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vces-vce--vnf-id--licenses-get">GET /network/vces/vce/{vnf-id}/licenses</a></td>
+ <td><p>returns licenses</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vces-vce--vnf-id--licenses-license--group-uuid---resource-uuid--get">GET /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}</a></td>
+ <td><p>returns license</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vces-vce--vnf-id--licenses-license--group-uuid---resource-uuid--put">PUT /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}</a></td>
+ <td><p>create or update an existing license</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vces-vce--vnf-id--licenses-license--group-uuid---resource-uuid--patch">PATCH /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}</a></td>
+ <td><p>update an existing license</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vces-vce--vnf-id--licenses-license--group-uuid---resource-uuid--delete">DELETE /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}</a></td>
+ <td><p>delete an existing license</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vces-vce--vnf-id--licenses-license--group-uuid---resource-uuid--relationship-list-relationship-put">PUT /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vces-vce--vnf-id--licenses-license--group-uuid---resource-uuid--relationship-list-relationship-delete">DELETE /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vces-vce--vnf-id--port-groups-get">GET /network/vces/vce/{vnf-id}/port-groups</a></td>
+ <td><p>returns port-groups</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vces-vce--vnf-id--port-groups-port-group--interface-id--get">GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}</a></td>
+ <td><p>returns port-group</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vces-vce--vnf-id--port-groups-port-group--interface-id--put">PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}</a></td>
+ <td><p>create or update an existing port-group</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vces-vce--vnf-id--port-groups-port-group--interface-id--patch">PATCH /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}</a></td>
+ <td><p>update an existing port-group</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vces-vce--vnf-id--port-groups-port-group--interface-id--delete">DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}</a></td>
+ <td><p>delete an existing port-group</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vces-vce--vnf-id--port-groups-port-group--interface-id--cvlan-tags-get">GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags</a></td>
+ <td><p>returns cvlan-tags</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vces-vce--vnf-id--port-groups-port-group--interface-id--cvlan-tags-cvlan-tag-entry--cvlan-tag--get">GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}</a></td>
+ <td><p>returns cvlan-tag-entry</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vces-vce--vnf-id--port-groups-port-group--interface-id--cvlan-tags-cvlan-tag-entry--cvlan-tag--put">PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}</a></td>
+ <td><p>create or update an existing cvlan-tag-entry</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vces-vce--vnf-id--port-groups-port-group--interface-id--cvlan-tags-cvlan-tag-entry--cvlan-tag--patch">PATCH /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}</a></td>
+ <td><p>update an existing cvlan-tag-entry</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vces-vce--vnf-id--port-groups-port-group--interface-id--cvlan-tags-cvlan-tag-entry--cvlan-tag--delete">DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}</a></td>
+ <td><p>delete an existing cvlan-tag-entry</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vces-vce--vnf-id--port-groups-port-group--interface-id--cvlan-tags-cvlan-tag-entry--cvlan-tag--relationship-list-relationship-put">PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vces-vce--vnf-id--port-groups-port-group--interface-id--cvlan-tags-cvlan-tag-entry--cvlan-tag--relationship-list-relationship-delete">DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vces-vce--vnf-id--port-groups-port-group--interface-id--relationship-list-relationship-put">PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vces-vce--vnf-id--port-groups-port-group--interface-id--relationship-list-relationship-delete">DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vces-vce--vnf-id--relationship-list-relationship-put">PUT /network/vces/vce/{vnf-id}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vces-vce--vnf-id--relationship-list-relationship-delete">DELETE /network/vces/vce/{vnf-id}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vnfcs-get">GET /network/vnfcs</a></td>
+ <td><p>returns vnfcs</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vnfcs-vnfc--vnfc-name--get">GET /network/vnfcs/vnfc/{vnfc-name}</a></td>
+ <td><p>returns vnfc</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vnfcs-vnfc--vnfc-name--put">PUT /network/vnfcs/vnfc/{vnfc-name}</a></td>
+ <td><p>create or update an existing vnfc</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vnfcs-vnfc--vnfc-name--patch">PATCH /network/vnfcs/vnfc/{vnfc-name}</a></td>
+ <td><p>update an existing vnfc</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vnfcs-vnfc--vnfc-name--delete">DELETE /network/vnfcs/vnfc/{vnfc-name}</a></td>
+ <td><p>delete an existing vnfc</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vnfcs-vnfc--vnfc-name--l3-interface-ipv4-address-list--l3-interface-ipv4-address--get">GET /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}</a></td>
+ <td><p>returns l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vnfcs-vnfc--vnfc-name--l3-interface-ipv4-address-list--l3-interface-ipv4-address--put">PUT /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}</a></td>
+ <td><p>create or update an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vnfcs-vnfc--vnfc-name--l3-interface-ipv4-address-list--l3-interface-ipv4-address--patch">PATCH /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}</a></td>
+ <td><p>update an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vnfcs-vnfc--vnfc-name--l3-interface-ipv4-address-list--l3-interface-ipv4-address--delete">DELETE /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}</a></td>
+ <td><p>delete an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vnfcs-vnfc--vnfc-name--l3-interface-ipv4-address-list--l3-interface-ipv4-address--relationship-list-relationship-put">PUT /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vnfcs-vnfc--vnfc-name--l3-interface-ipv4-address-list--l3-interface-ipv4-address--relationship-list-relationship-delete">DELETE /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vnfcs-vnfc--vnfc-name--l3-interface-ipv6-address-list--l3-interface-ipv6-address--get">GET /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}</a></td>
+ <td><p>returns l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vnfcs-vnfc--vnfc-name--l3-interface-ipv6-address-list--l3-interface-ipv6-address--put">PUT /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}</a></td>
+ <td><p>create or update an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vnfcs-vnfc--vnfc-name--l3-interface-ipv6-address-list--l3-interface-ipv6-address--patch">PATCH /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}</a></td>
+ <td><p>update an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vnfcs-vnfc--vnfc-name--l3-interface-ipv6-address-list--l3-interface-ipv6-address--delete">DELETE /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}</a></td>
+ <td><p>delete an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vnfcs-vnfc--vnfc-name--l3-interface-ipv6-address-list--l3-interface-ipv6-address--relationship-list-relationship-put">PUT /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vnfcs-vnfc--vnfc-name--l3-interface-ipv6-address-list--l3-interface-ipv6-address--relationship-list-relationship-delete">DELETE /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vnfcs-vnfc--vnfc-name--relationship-list-relationship-put">PUT /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vnfcs-vnfc--vnfc-name--relationship-list-relationship-delete">DELETE /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpls-pes-get">GET /network/vpls-pes</a></td>
+ <td><p>returns vpls-pes</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpls-pes-vpls-pe--equipment-name--get">GET /network/vpls-pes/vpls-pe/{equipment-name}</a></td>
+ <td><p>returns vpls-pe</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpls-pes-vpls-pe--equipment-name--put">PUT /network/vpls-pes/vpls-pe/{equipment-name}</a></td>
+ <td><p>create or update an existing vpls-pe</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpls-pes-vpls-pe--equipment-name--patch">PATCH /network/vpls-pes/vpls-pe/{equipment-name}</a></td>
+ <td><p>update an existing vpls-pe</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpls-pes-vpls-pe--equipment-name--delete">DELETE /network/vpls-pes/vpls-pe/{equipment-name}</a></td>
+ <td><p>delete an existing vpls-pe</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-get">GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces</a></td>
+ <td><p>returns lag-interfaces</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--get">GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}</a></td>
+ <td><p>returns lag-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--put">PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}</a></td>
+ <td><p>create or update an existing lag-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--patch">PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}</a></td>
+ <td><p>update an existing lag-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--delete">DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}</a></td>
+ <td><p>delete an existing lag-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--l-interfaces-get">GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces</a></td>
+ <td><p>returns l-interfaces</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--get">GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</a></td>
+ <td><p>returns l-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--put">PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</a></td>
+ <td><p>create or update an existing l-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--patch">PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</a></td>
+ <td><p>update an existing l-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--delete">DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</a></td>
+ <td><p>delete an existing l-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>returns l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>create or update an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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--patch">PATCH /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}</a></td>
+ <td><p>update an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>delete an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>returns l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>create or update an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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--patch">PATCH /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}</a></td>
+ <td><p>update an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>delete an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--relationship-list-relationship-put">PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--relationship-list-relationship-delete">DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-get">GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs</a></td>
+ <td><p>returns sriov-vfs</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>returns sriov-vf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>create or update an existing sriov-vf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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--patch">PATCH /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}</a></td>
+ <td><p>update an existing sriov-vf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>delete an existing sriov-vf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-get">GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans</a></td>
+ <td><p>returns vlans</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</a></td>
+ <td><p>returns vlan</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</a></td>
+ <td><p>create or update an existing vlan</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--patch">PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</a></td>
+ <td><p>update an existing vlan</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</a></td>
+ <td><p>delete an existing vlan</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>returns l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>create or update an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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--patch">PATCH /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}</a></td>
+ <td><p>update an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>delete an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>returns l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>create or update an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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--patch">PATCH /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}</a></td>
+ <td><p>update an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>delete an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--relationship-list-relationship-put">PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--relationship-list-relationship-delete">DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-get">GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces</a></td>
+ <td><p>returns p-interfaces</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--get">GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}</a></td>
+ <td><p>returns p-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--put">PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}</a></td>
+ <td><p>create or update an existing p-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--patch">PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}</a></td>
+ <td><p>update an existing p-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--delete">DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}</a></td>
+ <td><p>delete an existing p-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--l-interfaces-get">GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces</a></td>
+ <td><p>returns l-interfaces</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--get">GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</a></td>
+ <td><p>returns l-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--put">PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</a></td>
+ <td><p>create or update an existing l-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--patch">PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</a></td>
+ <td><p>update an existing l-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--delete">DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</a></td>
+ <td><p>delete an existing l-interface</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>returns l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>create or update an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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--patch">PATCH /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}</a></td>
+ <td><p>update an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>delete an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>returns l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>create or update an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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--patch">PATCH /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}</a></td>
+ <td><p>update an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>delete an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--relationship-list-relationship-put">PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--relationship-list-relationship-delete">DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-get">GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs</a></td>
+ <td><p>returns sriov-vfs</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>returns sriov-vf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>create or update an existing sriov-vf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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--patch">PATCH /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}</a></td>
+ <td><p>update an existing sriov-vf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>delete an existing sriov-vf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-get">GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans</a></td>
+ <td><p>returns vlans</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</a></td>
+ <td><p>returns vlan</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</a></td>
+ <td><p>create or update an existing vlan</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--patch">PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</a></td>
+ <td><p>update an existing vlan</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</a></td>
+ <td><p>delete an existing vlan</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>returns l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>create or update an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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--patch">PATCH /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}</a></td>
+ <td><p>update an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>delete an existing l3-interface-ipv4-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>returns l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>create or update an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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--patch">PATCH /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}</a></td>
+ <td><p>update an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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}</a></td>
+ <td><p>delete an existing l3-interface-ipv6-address-list</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">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</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--relationship-list-relationship-put">PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--relationship-list-relationship-delete">DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--sriov-pfs-get">GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs</a></td>
+ <td><p>returns sriov-pfs</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--get">GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}</a></td>
+ <td><p>returns sriov-pf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--put">PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}</a></td>
+ <td><p>create or update an existing sriov-pf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--patch">PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}</a></td>
+ <td><p>update an existing sriov-pf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--delete">DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}</a></td>
+ <td><p>delete an existing sriov-pf</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#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">DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpls-pes-vpls-pe--equipment-name--relationship-list-relationship-put">PUT /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpls-pes-vpls-pe--equipment-name--relationship-list-relationship-delete">DELETE /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpn-bindings-get">GET /network/vpn-bindings</a></td>
+ <td><p>returns vpn-bindings</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpn-bindings-vpn-binding--vpn-id--get">GET /network/vpn-bindings/vpn-binding/{vpn-id}</a></td>
+ <td><p>returns vpn-binding</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpn-bindings-vpn-binding--vpn-id--put">PUT /network/vpn-bindings/vpn-binding/{vpn-id}</a></td>
+ <td><p>create or update an existing vpn-binding</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpn-bindings-vpn-binding--vpn-id--patch">PATCH /network/vpn-bindings/vpn-binding/{vpn-id}</a></td>
+ <td><p>update an existing vpn-binding</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpn-bindings-vpn-binding--vpn-id--delete">DELETE /network/vpn-bindings/vpn-binding/{vpn-id}</a></td>
+ <td><p>delete an existing vpn-binding</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpn-bindings-vpn-binding--vpn-id--relationship-list-relationship-put">PUT /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpn-bindings-vpn-binding--vpn-id--relationship-list-relationship-delete">DELETE /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpn-bindings-vpn-binding--vpn-id--route-targets-get">GET /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets</a></td>
+ <td><p>returns route-targets</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpn-bindings-vpn-binding--vpn-id--route-targets-route-target--global-route-target---route-target-role--get">GET /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}</a></td>
+ <td><p>returns route-target</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpn-bindings-vpn-binding--vpn-id--route-targets-route-target--global-route-target---route-target-role--put">PUT /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}</a></td>
+ <td><p>create or update an existing route-target</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpn-bindings-vpn-binding--vpn-id--route-targets-route-target--global-route-target---route-target-role--patch">PATCH /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}</a></td>
+ <td><p>update an existing route-target</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpn-bindings-vpn-binding--vpn-id--route-targets-route-target--global-route-target---route-target-role--delete">DELETE /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}</a></td>
+ <td><p>delete an existing route-target</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpn-bindings-vpn-binding--vpn-id--route-targets-route-target--global-route-target---route-target-role--relationship-list-relationship-put">PUT /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-vpn-bindings-vpn-binding--vpn-id--route-targets-route-target--global-route-target---route-target-role--relationship-list-relationship-delete">DELETE /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-zones-get">GET /network/zones</a></td>
+ <td><p>returns zones</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-zones-zone--zone-id--get">GET /network/zones/zone/{zone-id}</a></td>
+ <td><p>returns zone</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-zones-zone--zone-id--put">PUT /network/zones/zone/{zone-id}</a></td>
+ <td><p>create or update an existing zone</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-zones-zone--zone-id--patch">PATCH /network/zones/zone/{zone-id}</a></td>
+ <td><p>update an existing zone</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-zones-zone--zone-id--delete">DELETE /network/zones/zone/{zone-id}</a></td>
+ <td><p>delete an existing zone</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-zones-zone--zone-id--relationship-list-relationship-put">PUT /network/zones/zone/{zone-id}/relationship-list/relationship</a></td>
+ <td><p>see node definition for valid relationships</p>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#operation--network-zones-zone--zone-id--relationship-list-relationship-delete">DELETE /network/zones/zone/{zone-id}/relationship-list/relationship</a></td>
+ <td><p>delete an existing relationship</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+
+
+
+ <h2>Paths</h2>
+
+
+ <span id="path--business-connectors-"></span>
+ <div id="operation--business-connectors-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns connectors</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/business/connectors</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns connectors</p>
+
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/connectors">/connectors</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-connectors-connector--resource-instance-id--"></span>
+ <div id="operation--business-connectors-connector--resource-instance-id--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns connector</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/business/connectors/connector/{resource-instance-id}</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns connector</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ resource-instance-id
+ </td>
+ <td>
+ <p>Unique id of resource instance.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-id
+ </td>
+ <td>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-version
+ </td>
+ <td>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/connector">/connector</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-connectors-connector--resource-instance-id--"></span>
+ <div id="operation--business-connectors-connector--resource-instance-id--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing connector</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/business/connectors/connector/{resource-instance-id}</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing connector</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>connector object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessConnectorsConnector.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/connector">/connector</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ resource-instance-id
+ </td>
+ <td>
+ <p>Unique id of resource instance.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-connectors-connector--resource-instance-id--"></span>
+ <div id="operation--business-connectors-connector--resource-instance-id--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing connector</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/business/connectors/connector/{resource-instance-id}</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing connector</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>connector object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/connector">/connector</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ resource-instance-id
+ </td>
+ <td>
+ <p>Unique id of resource instance.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-connectors-connector--resource-instance-id--"></span>
+ <div id="operation--business-connectors-connector--resource-instance-id--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing connector</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/business/connectors/connector/{resource-instance-id}</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing connector</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ resource-instance-id
+ </td>
+ <td>
+ <p>Unique id of resource instance.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-connectors-connector--resource-instance-id--metadata-"></span>
+ <div id="operation--business-connectors-connector--resource-instance-id--metadata-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns metadata</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/business/connectors/connector/{resource-instance-id}/metadata</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns metadata</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ resource-instance-id
+ </td>
+ <td>
+ <p>Unique id of resource instance.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-id
+ </td>
+ <td>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-version
+ </td>
+ <td>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/metadata">/metadata</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-connectors-connector--resource-instance-id--metadata-metadatum--metaname--"></span>
+ <div id="operation--business-connectors-connector--resource-instance-id--metadata-metadatum--metaname--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns metadatum</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns metadatum</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ resource-instance-id
+ </td>
+ <td>
+ <p>Unique id of resource instance.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ metaname
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-id
+ </td>
+ <td>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-version
+ </td>
+ <td>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/metadatum">/metadatum</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-connectors-connector--resource-instance-id--metadata-metadatum--metaname--"></span>
+ <div id="operation--business-connectors-connector--resource-instance-id--metadata-metadatum--metaname--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing metadatum</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing metadatum</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessConnectorsConnectorMetadataMetadatum.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/metadatum">/metadatum</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ resource-instance-id
+ </td>
+ <td>
+ <p>Unique id of resource instance.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ metaname
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-connectors-connector--resource-instance-id--metadata-metadatum--metaname--"></span>
+ <div id="operation--business-connectors-connector--resource-instance-id--metadata-metadatum--metaname--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing metadatum</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing metadatum</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>metadatum object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/metadatum">/metadatum</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ resource-instance-id
+ </td>
+ <td>
+ <p>Unique id of resource instance.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ metaname
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-connectors-connector--resource-instance-id--metadata-metadatum--metaname--"></span>
+ <div id="operation--business-connectors-connector--resource-instance-id--metadata-metadatum--metaname--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing metadatum</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing metadatum</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ resource-instance-id
+ </td>
+ <td>
+ <p>Unique id of resource instance.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ metaname
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-connectors-connector--resource-instance-id--relationship-list-relationship-"></span>
+ <div id="operation--business-connectors-connector--resource-instance-id--relationship-list-relationship-put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/business/connectors/connector/{resource-instance-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessConnectorsConnector.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ resource-instance-id
+ </td>
+ <td>
+ <p>Unique id of resource instance.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-connectors-connector--resource-instance-id--relationship-list-relationship-"></span>
+ <div id="operation--business-connectors-connector--resource-instance-id--relationship-list-relationship-delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/business/connectors/connector/{resource-instance-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ resource-instance-id
+ </td>
+ <td>
+ <p>Unique id of resource instance.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-customers-"></span>
+ <div id="operation--business-customers-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns customers</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/business/customers</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns customers</p>
+
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/customers">/customers</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-customers-customer--global-customer-id--"></span>
+ <div id="operation--business-customers-customer--global-customer-id--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns customer</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/business/customers/customer/{global-customer-id}</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns customer</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ global-customer-id
+ </td>
+ <td>
+ <p>Global customer id used across ECOMP to uniquely identify customer.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ subscriber-name
+ </td>
+ <td>
+ <p>Subscriber name, an alternate way to retrieve a customer.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ subscriber-type
+ </td>
+ <td>
+ <p>Subscriber type, a way to provide VID with only the INFRA customers.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/customer">/customer</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-customers-customer--global-customer-id--"></span>
+ <div id="operation--business-customers-customer--global-customer-id--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing customer</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/business/customers/customer/{global-customer-id}</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing customer</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>customer object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomer.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/customer">/customer</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ global-customer-id
+ </td>
+ <td>
+ <p>Global customer id used across ECOMP to uniquely identify customer.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-customers-customer--global-customer-id--"></span>
+ <div id="operation--business-customers-customer--global-customer-id--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing customer</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/business/customers/customer/{global-customer-id}</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing customer</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>customer object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/customer">/customer</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ global-customer-id
+ </td>
+ <td>
+ <p>Global customer id used across ECOMP to uniquely identify customer.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-customers-customer--global-customer-id--"></span>
+ <div id="operation--business-customers-customer--global-customer-id--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing customer</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/business/customers/customer/{global-customer-id}</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing customer</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ global-customer-id
+ </td>
+ <td>
+ <p>Global customer id used across ECOMP to uniquely identify customer.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-customers-customer--global-customer-id--relationship-list-relationship-"></span>
+ <div id="operation--business-customers-customer--global-customer-id--relationship-list-relationship-put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/business/customers/customer/{global-customer-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomer.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ global-customer-id
+ </td>
+ <td>
+ <p>Global customer id used across ECOMP to uniquely identify customer.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-customers-customer--global-customer-id--relationship-list-relationship-"></span>
+ <div id="operation--business-customers-customer--global-customer-id--relationship-list-relationship-delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/business/customers/customer/{global-customer-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ global-customer-id
+ </td>
+ <td>
+ <p>Global customer id used across ECOMP to uniquely identify customer.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-customers-customer--global-customer-id--service-subscriptions-"></span>
+ <div id="operation--business-customers-customer--global-customer-id--service-subscriptions-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns service-subscriptions</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/business/customers/customer/{global-customer-id}/service-subscriptions</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns service-subscriptions</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ global-customer-id
+ </td>
+ <td>
+ <p>Global customer id used across ECOMP to uniquely identify customer.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ subscriber-name
+ </td>
+ <td>
+ <p>Subscriber name, an alternate way to retrieve a customer.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ subscriber-type
+ </td>
+ <td>
+ <p>Subscriber type, a way to provide VID with only the INFRA customers.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/service-subscriptions">/service-subscriptions</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--"></span>
+ <div id="operation--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns service-subscription</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns service-subscription</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ global-customer-id
+ </td>
+ <td>
+ <p>Global customer id used across ECOMP to uniquely identify customer.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-type
+ </td>
+ <td>
+ <p>Value defined by orchestration to identify this service across ECOMP.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ subscriber-name
+ </td>
+ <td>
+ <p>Subscriber name, an alternate way to retrieve a customer.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ subscriber-type
+ </td>
+ <td>
+ <p>Subscriber type, a way to provide VID with only the INFRA customers.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/service-subscription">/service-subscription</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--"></span>
+ <div id="operation--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing service-subscription</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing service-subscription</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>service-subscription object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/service-subscription">/service-subscription</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ global-customer-id
+ </td>
+ <td>
+ <p>Global customer id used across ECOMP to uniquely identify customer.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-type
+ </td>
+ <td>
+ <p>Value defined by orchestration to identify this service across ECOMP.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--"></span>
+ <div id="operation--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing service-subscription</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing service-subscription</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>service-subscription object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/service-subscription">/service-subscription</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ global-customer-id
+ </td>
+ <td>
+ <p>Global customer id used across ECOMP to uniquely identify customer.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-type
+ </td>
+ <td>
+ <p>Value defined by orchestration to identify this service across ECOMP.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--"></span>
+ <div id="operation--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing service-subscription</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing service-subscription</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ global-customer-id
+ </td>
+ <td>
+ <p>Global customer id used across ECOMP to uniquely identify customer.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-type
+ </td>
+ <td>
+ <p>Value defined by orchestration to identify this service across ECOMP.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ global-customer-id
+ </td>
+ <td>
+ <p>Global customer id used across ECOMP to uniquely identify customer.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-type
+ </td>
+ <td>
+ <p>Value defined by orchestration to identify this service across ECOMP.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ global-customer-id
+ </td>
+ <td>
+ <p>Global customer id used across ECOMP to uniquely identify customer.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-type
+ </td>
+ <td>
+ <p>Value defined by orchestration to identify this service across ECOMP.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--service-instances-"></span>
+ <div id="operation--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--service-instances-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns service-instances</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns service-instances</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ global-customer-id
+ </td>
+ <td>
+ <p>Global customer id used across ECOMP to uniquely identify customer.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-type
+ </td>
+ <td>
+ <p>Value defined by orchestration to identify this service across ECOMP.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ subscriber-name
+ </td>
+ <td>
+ <p>Subscriber name, an alternate way to retrieve a customer.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ subscriber-type
+ </td>
+ <td>
+ <p>Subscriber type, a way to provide VID with only the INFRA customers.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/service-instances">/service-instances</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--service-instances-service-instance--service-instance-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns service-instance</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns service-instance</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ global-customer-id
+ </td>
+ <td>
+ <p>Global customer id used across ECOMP to uniquely identify customer.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-type
+ </td>
+ <td>
+ <p>Value defined by orchestration to identify this service across ECOMP.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-instance-id
+ </td>
+ <td>
+ <p>Uniquely identifies this instance of a service</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ subscriber-name
+ </td>
+ <td>
+ <p>Subscriber name, an alternate way to retrieve a customer.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ subscriber-type
+ </td>
+ <td>
+ <p>Subscriber type, a way to provide VID with only the INFRA customers.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-instance-name
+ </td>
+ <td>
+ <p>This field will store a name assigned to the service-instance.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ environment-context
+ </td>
+ <td>
+ <p>This field will store the environment context assigned to the service-instance.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ workload-context
+ </td>
+ <td>
+ <p>This field will store the workload context assigned to the service-instance.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-id
+ </td>
+ <td>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-version
+ </td>
+ <td>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-instance-location-id
+ </td>
+ <td>
+ <p>An identifier that customers assign to the location where this service is being used.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ orchestration-status
+ </td>
+ <td>
+ <p>Orchestration status of this service.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/service-instance">/service-instance</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--service-instances-service-instance--service-instance-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing service-instance</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing service-instance</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>service-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/service-instance">/service-instance</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ global-customer-id
+ </td>
+ <td>
+ <p>Global customer id used across ECOMP to uniquely identify customer.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-type
+ </td>
+ <td>
+ <p>Value defined by orchestration to identify this service across ECOMP.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-instance-id
+ </td>
+ <td>
+ <p>Uniquely identifies this instance of a service</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--service-instances-service-instance--service-instance-id--"></span>
+ <div id="operation--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--service-instances-service-instance--service-instance-id--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing service-instance</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing service-instance</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>service-instance object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/service-instance">/service-instance</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ global-customer-id
+ </td>
+ <td>
+ <p>Global customer id used across ECOMP to uniquely identify customer.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-type
+ </td>
+ <td>
+ <p>Value defined by orchestration to identify this service across ECOMP.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-instance-id
+ </td>
+ <td>
+ <p>Uniquely identifies this instance of a service</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--service-instances-service-instance--service-instance-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing service-instance</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing service-instance</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ global-customer-id
+ </td>
+ <td>
+ <p>Global customer id used across ECOMP to uniquely identify customer.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-type
+ </td>
+ <td>
+ <p>Value defined by orchestration to identify this service across ECOMP.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-instance-id
+ </td>
+ <td>
+ <p>Uniquely identifies this instance of a service</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--service-instances-service-instance--service-instance-id--allotted-resources-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns allotted-resources</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns allotted-resources</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ global-customer-id
+ </td>
+ <td>
+ <p>Global customer id used across ECOMP to uniquely identify customer.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-type
+ </td>
+ <td>
+ <p>Value defined by orchestration to identify this service across ECOMP.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-instance-id
+ </td>
+ <td>
+ <p>Uniquely identifies this instance of a service</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ subscriber-name
+ </td>
+ <td>
+ <p>Subscriber name, an alternate way to retrieve a customer.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ subscriber-type
+ </td>
+ <td>
+ <p>Subscriber type, a way to provide VID with only the INFRA customers.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-instance-name
+ </td>
+ <td>
+ <p>This field will store a name assigned to the service-instance.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ environment-context
+ </td>
+ <td>
+ <p>This field will store the environment context assigned to the service-instance.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ workload-context
+ </td>
+ <td>
+ <p>This field will store the workload context assigned to the service-instance.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-id
+ </td>
+ <td>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-version
+ </td>
+ <td>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-instance-location-id
+ </td>
+ <td>
+ <p>An identifier that customers assign to the location where this service is being used.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ orchestration-status
+ </td>
+ <td>
+ <p>Orchestration status of this service.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/allotted-resources">/allotted-resources</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--service-instances-service-instance--service-instance-id--allotted-resources-allotted-resource--id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns allotted-resource</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns allotted-resource</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ global-customer-id
+ </td>
+ <td>
+ <p>Global customer id used across ECOMP to uniquely identify customer.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-type
+ </td>
+ <td>
+ <p>Value defined by orchestration to identify this service across ECOMP.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-instance-id
+ </td>
+ <td>
+ <p>Uniquely identifies this instance of a service</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ id
+ </td>
+ <td>
+ <p>Allotted Resource id UUID assigned to this instance.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ subscriber-name
+ </td>
+ <td>
+ <p>Subscriber name, an alternate way to retrieve a customer.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ subscriber-type
+ </td>
+ <td>
+ <p>Subscriber type, a way to provide VID with only the INFRA customers.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-instance-name
+ </td>
+ <td>
+ <p>This field will store a name assigned to the service-instance.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ environment-context
+ </td>
+ <td>
+ <p>This field will store the environment context assigned to the service-instance.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ workload-context
+ </td>
+ <td>
+ <p>This field will store the workload context assigned to the service-instance.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-id
+ </td>
+ <td>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-version
+ </td>
+ <td>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-instance-location-id
+ </td>
+ <td>
+ <p>An identifier that customers assign to the location where this service is being used.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ orchestration-status
+ </td>
+ <td>
+ <p>Orchestration status of this service.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ type
+ </td>
+ <td>
+ <p>Generic description of the type of allotted resource.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ role
+ </td>
+ <td>
+ <p>role in the network that this resource will be providing.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/allotted-resource">/allotted-resource</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--service-instances-service-instance--service-instance-id--allotted-resources-allotted-resource--id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing allotted-resource</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing allotted-resource</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>allotted-resource object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/allotted-resource">/allotted-resource</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ global-customer-id
+ </td>
+ <td>
+ <p>Global customer id used across ECOMP to uniquely identify customer.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-type
+ </td>
+ <td>
+ <p>Value defined by orchestration to identify this service across ECOMP.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-instance-id
+ </td>
+ <td>
+ <p>Uniquely identifies this instance of a service</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ id
+ </td>
+ <td>
+ <p>Allotted Resource id UUID assigned to this instance.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--service-instances-service-instance--service-instance-id--allotted-resources-allotted-resource--id--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing allotted-resource</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing allotted-resource</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>allotted-resource object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/allotted-resource">/allotted-resource</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ global-customer-id
+ </td>
+ <td>
+ <p>Global customer id used across ECOMP to uniquely identify customer.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-type
+ </td>
+ <td>
+ <p>Value defined by orchestration to identify this service across ECOMP.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-instance-id
+ </td>
+ <td>
+ <p>Uniquely identifies this instance of a service</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ id
+ </td>
+ <td>
+ <p>Allotted Resource id UUID assigned to this instance.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--service-instances-service-instance--service-instance-id--allotted-resources-allotted-resource--id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing allotted-resource</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing allotted-resource</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ global-customer-id
+ </td>
+ <td>
+ <p>Global customer id used across ECOMP to uniquely identify customer.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-type
+ </td>
+ <td>
+ <p>Value defined by orchestration to identify this service across ECOMP.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-instance-id
+ </td>
+ <td>
+ <p>Uniquely identifies this instance of a service</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ id
+ </td>
+ <td>
+ <p>Allotted Resource id UUID assigned to this instance.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ global-customer-id
+ </td>
+ <td>
+ <p>Global customer id used across ECOMP to uniquely identify customer.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-type
+ </td>
+ <td>
+ <p>Value defined by orchestration to identify this service across ECOMP.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-instance-id
+ </td>
+ <td>
+ <p>Uniquely identifies this instance of a service</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ id
+ </td>
+ <td>
+ <p>Allotted Resource id UUID assigned to this instance.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ global-customer-id
+ </td>
+ <td>
+ <p>Global customer id used across ECOMP to uniquely identify customer.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-type
+ </td>
+ <td>
+ <p>Value defined by orchestration to identify this service across ECOMP.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-instance-id
+ </td>
+ <td>
+ <p>Uniquely identifies this instance of a service</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ id
+ </td>
+ <td>
+ <p>Allotted Resource id UUID assigned to this instance.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns tunnel-xconnects</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns tunnel-xconnects</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ global-customer-id
+ </td>
+ <td>
+ <p>Global customer id used across ECOMP to uniquely identify customer.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-type
+ </td>
+ <td>
+ <p>Value defined by orchestration to identify this service across ECOMP.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-instance-id
+ </td>
+ <td>
+ <p>Uniquely identifies this instance of a service</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ id
+ </td>
+ <td>
+ <p>Allotted Resource id UUID assigned to this instance.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ subscriber-name
+ </td>
+ <td>
+ <p>Subscriber name, an alternate way to retrieve a customer.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ subscriber-type
+ </td>
+ <td>
+ <p>Subscriber type, a way to provide VID with only the INFRA customers.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-instance-name
+ </td>
+ <td>
+ <p>This field will store a name assigned to the service-instance.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ environment-context
+ </td>
+ <td>
+ <p>This field will store the environment context assigned to the service-instance.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ workload-context
+ </td>
+ <td>
+ <p>This field will store the workload context assigned to the service-instance.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-id
+ </td>
+ <td>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-version
+ </td>
+ <td>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-instance-location-id
+ </td>
+ <td>
+ <p>An identifier that customers assign to the location where this service is being used.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ orchestration-status
+ </td>
+ <td>
+ <p>Orchestration status of this service.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ type
+ </td>
+ <td>
+ <p>Generic description of the type of allotted resource.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ role
+ </td>
+ <td>
+ <p>role in the network that this resource will be providing.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/tunnel-xconnects">/tunnel-xconnects</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns tunnel-xconnect</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns tunnel-xconnect</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ global-customer-id
+ </td>
+ <td>
+ <p>Global customer id used across ECOMP to uniquely identify customer.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-type
+ </td>
+ <td>
+ <p>Value defined by orchestration to identify this service across ECOMP.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-instance-id
+ </td>
+ <td>
+ <p>Uniquely identifies this instance of a service</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ id
+ </td>
+ <td>
+ <p>Allotted Resource id UUID assigned to this instance.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ id
+ </td>
+ <td>
+ <p>Allotted Resource id UUID assigned to this instance.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ subscriber-name
+ </td>
+ <td>
+ <p>Subscriber name, an alternate way to retrieve a customer.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ subscriber-type
+ </td>
+ <td>
+ <p>Subscriber type, a way to provide VID with only the INFRA customers.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-instance-name
+ </td>
+ <td>
+ <p>This field will store a name assigned to the service-instance.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ environment-context
+ </td>
+ <td>
+ <p>This field will store the environment context assigned to the service-instance.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ workload-context
+ </td>
+ <td>
+ <p>This field will store the workload context assigned to the service-instance.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-id
+ </td>
+ <td>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-version
+ </td>
+ <td>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-instance-location-id
+ </td>
+ <td>
+ <p>An identifier that customers assign to the location where this service is being used.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ orchestration-status
+ </td>
+ <td>
+ <p>Orchestration status of this service.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ type
+ </td>
+ <td>
+ <p>Generic description of the type of allotted resource.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ role
+ </td>
+ <td>
+ <p>role in the network that this resource will be providing.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/tunnel-xconnect">/tunnel-xconnect</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing tunnel-xconnect</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing tunnel-xconnect</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>tunnel-xconnect object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/tunnel-xconnect">/tunnel-xconnect</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ global-customer-id
+ </td>
+ <td>
+ <p>Global customer id used across ECOMP to uniquely identify customer.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-type
+ </td>
+ <td>
+ <p>Value defined by orchestration to identify this service across ECOMP.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-instance-id
+ </td>
+ <td>
+ <p>Uniquely identifies this instance of a service</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ id
+ </td>
+ <td>
+ <p>Allotted Resource id UUID assigned to this instance.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ id
+ </td>
+ <td>
+ <p>Allotted Resource id UUID assigned to this instance.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing tunnel-xconnect</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing tunnel-xconnect</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>tunnel-xconnect object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/tunnel-xconnect">/tunnel-xconnect</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ global-customer-id
+ </td>
+ <td>
+ <p>Global customer id used across ECOMP to uniquely identify customer.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-type
+ </td>
+ <td>
+ <p>Value defined by orchestration to identify this service across ECOMP.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-instance-id
+ </td>
+ <td>
+ <p>Uniquely identifies this instance of a service</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ id
+ </td>
+ <td>
+ <p>Allotted Resource id UUID assigned to this instance.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ id
+ </td>
+ <td>
+ <p>Allotted Resource id UUID assigned to this instance.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing tunnel-xconnect</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing tunnel-xconnect</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ global-customer-id
+ </td>
+ <td>
+ <p>Global customer id used across ECOMP to uniquely identify customer.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-type
+ </td>
+ <td>
+ <p>Value defined by orchestration to identify this service across ECOMP.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-instance-id
+ </td>
+ <td>
+ <p>Uniquely identifies this instance of a service</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ id
+ </td>
+ <td>
+ <p>Allotted Resource id UUID assigned to this instance.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ id
+ </td>
+ <td>
+ <p>Allotted Resource id UUID assigned to this instance.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ global-customer-id
+ </td>
+ <td>
+ <p>Global customer id used across ECOMP to uniquely identify customer.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-type
+ </td>
+ <td>
+ <p>Value defined by orchestration to identify this service across ECOMP.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-instance-id
+ </td>
+ <td>
+ <p>Uniquely identifies this instance of a service</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ id
+ </td>
+ <td>
+ <p>Allotted Resource id UUID assigned to this instance.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ id
+ </td>
+ <td>
+ <p>Allotted Resource id UUID assigned to this instance.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ global-customer-id
+ </td>
+ <td>
+ <p>Global customer id used across ECOMP to uniquely identify customer.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-type
+ </td>
+ <td>
+ <p>Value defined by orchestration to identify this service across ECOMP.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-instance-id
+ </td>
+ <td>
+ <p>Uniquely identifies this instance of a service</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ id
+ </td>
+ <td>
+ <p>Allotted Resource id UUID assigned to this instance.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ id
+ </td>
+ <td>
+ <p>Allotted Resource id UUID assigned to this instance.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--service-instances-service-instance--service-instance-id--metadata-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns metadata</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns metadata</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ global-customer-id
+ </td>
+ <td>
+ <p>Global customer id used across ECOMP to uniquely identify customer.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-type
+ </td>
+ <td>
+ <p>Value defined by orchestration to identify this service across ECOMP.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-instance-id
+ </td>
+ <td>
+ <p>Uniquely identifies this instance of a service</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ subscriber-name
+ </td>
+ <td>
+ <p>Subscriber name, an alternate way to retrieve a customer.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ subscriber-type
+ </td>
+ <td>
+ <p>Subscriber type, a way to provide VID with only the INFRA customers.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-instance-name
+ </td>
+ <td>
+ <p>This field will store a name assigned to the service-instance.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ environment-context
+ </td>
+ <td>
+ <p>This field will store the environment context assigned to the service-instance.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ workload-context
+ </td>
+ <td>
+ <p>This field will store the workload context assigned to the service-instance.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-id
+ </td>
+ <td>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-version
+ </td>
+ <td>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-instance-location-id
+ </td>
+ <td>
+ <p>An identifier that customers assign to the location where this service is being used.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ orchestration-status
+ </td>
+ <td>
+ <p>Orchestration status of this service.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/metadata">/metadata</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--service-instances-service-instance--service-instance-id--metadata-metadatum--metaname--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns metadatum</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns metadatum</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ global-customer-id
+ </td>
+ <td>
+ <p>Global customer id used across ECOMP to uniquely identify customer.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-type
+ </td>
+ <td>
+ <p>Value defined by orchestration to identify this service across ECOMP.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-instance-id
+ </td>
+ <td>
+ <p>Uniquely identifies this instance of a service</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ metaname
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ subscriber-name
+ </td>
+ <td>
+ <p>Subscriber name, an alternate way to retrieve a customer.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ subscriber-type
+ </td>
+ <td>
+ <p>Subscriber type, a way to provide VID with only the INFRA customers.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-instance-name
+ </td>
+ <td>
+ <p>This field will store a name assigned to the service-instance.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ environment-context
+ </td>
+ <td>
+ <p>This field will store the environment context assigned to the service-instance.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ workload-context
+ </td>
+ <td>
+ <p>This field will store the workload context assigned to the service-instance.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-id
+ </td>
+ <td>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-version
+ </td>
+ <td>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-instance-location-id
+ </td>
+ <td>
+ <p>An identifier that customers assign to the location where this service is being used.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ orchestration-status
+ </td>
+ <td>
+ <p>Orchestration status of this service.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/metadatum">/metadatum</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--service-instances-service-instance--service-instance-id--metadata-metadatum--metaname--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing metadatum</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing metadatum</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/metadatum">/metadatum</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ global-customer-id
+ </td>
+ <td>
+ <p>Global customer id used across ECOMP to uniquely identify customer.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-type
+ </td>
+ <td>
+ <p>Value defined by orchestration to identify this service across ECOMP.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-instance-id
+ </td>
+ <td>
+ <p>Uniquely identifies this instance of a service</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ metaname
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--service-instances-service-instance--service-instance-id--metadata-metadatum--metaname--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing metadatum</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing metadatum</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>metadatum object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/metadatum">/metadatum</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ global-customer-id
+ </td>
+ <td>
+ <p>Global customer id used across ECOMP to uniquely identify customer.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-type
+ </td>
+ <td>
+ <p>Value defined by orchestration to identify this service across ECOMP.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-instance-id
+ </td>
+ <td>
+ <p>Uniquely identifies this instance of a service</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ metaname
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--service-instances-service-instance--service-instance-id--metadata-metadatum--metaname--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing metadatum</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing metadatum</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ global-customer-id
+ </td>
+ <td>
+ <p>Global customer id used across ECOMP to uniquely identify customer.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-type
+ </td>
+ <td>
+ <p>Value defined by orchestration to identify this service across ECOMP.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-instance-id
+ </td>
+ <td>
+ <p>Uniquely identifies this instance of a service</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ metaname
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--service-instances-service-instance--service-instance-id--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ global-customer-id
+ </td>
+ <td>
+ <p>Global customer id used across ECOMP to uniquely identify customer.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-type
+ </td>
+ <td>
+ <p>Value defined by orchestration to identify this service across ECOMP.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-instance-id
+ </td>
+ <td>
+ <p>Uniquely identifies this instance of a service</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--service-instances-service-instance--service-instance-id--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ global-customer-id
+ </td>
+ <td>
+ <p>Global customer id used across ECOMP to uniquely identify customer.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-type
+ </td>
+ <td>
+ <p>Value defined by orchestration to identify this service across ECOMP.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-instance-id
+ </td>
+ <td>
+ <p>Uniquely identifies this instance of a service</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-lines-of-business-"></span>
+ <div id="operation--business-lines-of-business-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns lines-of-business</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/business/lines-of-business</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns lines-of-business</p>
+
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/lines-of-business">/lines-of-business</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-lines-of-business-line-of-business--line-of-business-name--"></span>
+ <div id="operation--business-lines-of-business-line-of-business--line-of-business-name--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns line-of-business</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/business/lines-of-business/line-of-business/{line-of-business-name}</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns line-of-business</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ line-of-business-name
+ </td>
+ <td>
+ <p>Name of the line-of-business (product)</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/line-of-business">/line-of-business</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-lines-of-business-line-of-business--line-of-business-name--"></span>
+ <div id="operation--business-lines-of-business-line-of-business--line-of-business-name--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing line-of-business</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/business/lines-of-business/line-of-business/{line-of-business-name}</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing line-of-business</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>line-of-business object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessLinesOfBusinessLineOfBusiness.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/line-of-business">/line-of-business</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ line-of-business-name
+ </td>
+ <td>
+ <p>Name of the line-of-business (product)</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-lines-of-business-line-of-business--line-of-business-name--"></span>
+ <div id="operation--business-lines-of-business-line-of-business--line-of-business-name--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing line-of-business</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/business/lines-of-business/line-of-business/{line-of-business-name}</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing line-of-business</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>line-of-business object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/line-of-business">/line-of-business</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ line-of-business-name
+ </td>
+ <td>
+ <p>Name of the line-of-business (product)</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-lines-of-business-line-of-business--line-of-business-name--"></span>
+ <div id="operation--business-lines-of-business-line-of-business--line-of-business-name--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing line-of-business</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/business/lines-of-business/line-of-business/{line-of-business-name}</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing line-of-business</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ line-of-business-name
+ </td>
+ <td>
+ <p>Name of the line-of-business (product)</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-lines-of-business-line-of-business--line-of-business-name--relationship-list-relationship-"></span>
+ <div id="operation--business-lines-of-business-line-of-business--line-of-business-name--relationship-list-relationship-put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/business/lines-of-business/line-of-business/{line-of-business-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessLinesOfBusinessLineOfBusiness.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ line-of-business-name
+ </td>
+ <td>
+ <p>Name of the line-of-business (product)</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-lines-of-business-line-of-business--line-of-business-name--relationship-list-relationship-"></span>
+ <div id="operation--business-lines-of-business-line-of-business--line-of-business-name--relationship-list-relationship-delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/business/lines-of-business/line-of-business/{line-of-business-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ line-of-business-name
+ </td>
+ <td>
+ <p>Name of the line-of-business (product)</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-owning-entities-"></span>
+ <div id="operation--business-owning-entities-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns owning-entities</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/business/owning-entities</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns owning-entities</p>
+
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/owning-entities">/owning-entities</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-owning-entities-owning-entity--owning-entity-id--"></span>
+ <div id="operation--business-owning-entities-owning-entity--owning-entity-id--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns owning-entity</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/business/owning-entities/owning-entity/{owning-entity-id}</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns owning-entity</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ owning-entity-id
+ </td>
+ <td>
+ <p>UUID of an owning entity</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/owning-entity">/owning-entity</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-owning-entities-owning-entity--owning-entity-id--"></span>
+ <div id="operation--business-owning-entities-owning-entity--owning-entity-id--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing owning-entity</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/business/owning-entities/owning-entity/{owning-entity-id}</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing owning-entity</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>owning-entity object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessOwningEntitiesOwningEntity.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/owning-entity">/owning-entity</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ owning-entity-id
+ </td>
+ <td>
+ <p>UUID of an owning entity</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-owning-entities-owning-entity--owning-entity-id--"></span>
+ <div id="operation--business-owning-entities-owning-entity--owning-entity-id--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing owning-entity</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/business/owning-entities/owning-entity/{owning-entity-id}</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing owning-entity</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>owning-entity object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/owning-entity">/owning-entity</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ owning-entity-id
+ </td>
+ <td>
+ <p>UUID of an owning entity</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-owning-entities-owning-entity--owning-entity-id--"></span>
+ <div id="operation--business-owning-entities-owning-entity--owning-entity-id--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing owning-entity</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/business/owning-entities/owning-entity/{owning-entity-id}</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing owning-entity</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ owning-entity-id
+ </td>
+ <td>
+ <p>UUID of an owning entity</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-owning-entities-owning-entity--owning-entity-id--relationship-list-relationship-"></span>
+ <div id="operation--business-owning-entities-owning-entity--owning-entity-id--relationship-list-relationship-put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/business/owning-entities/owning-entity/{owning-entity-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessOwningEntitiesOwningEntity.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ owning-entity-id
+ </td>
+ <td>
+ <p>UUID of an owning entity</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-owning-entities-owning-entity--owning-entity-id--relationship-list-relationship-"></span>
+ <div id="operation--business-owning-entities-owning-entity--owning-entity-id--relationship-list-relationship-delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/business/owning-entities/owning-entity/{owning-entity-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ owning-entity-id
+ </td>
+ <td>
+ <p>UUID of an owning entity</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-platforms-"></span>
+ <div id="operation--business-platforms-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns platforms</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/business/platforms</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns platforms</p>
+
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/platforms">/platforms</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-platforms-platform--platform-name--"></span>
+ <div id="operation--business-platforms-platform--platform-name--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns platform</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/business/platforms/platform/{platform-name}</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns platform</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ platform-name
+ </td>
+ <td>
+ <p>Name of the platform</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/platform">/platform</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-platforms-platform--platform-name--"></span>
+ <div id="operation--business-platforms-platform--platform-name--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing platform</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/business/platforms/platform/{platform-name}</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing platform</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>platform object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessPlatformsPlatform.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/platform">/platform</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ platform-name
+ </td>
+ <td>
+ <p>Name of the platform</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-platforms-platform--platform-name--"></span>
+ <div id="operation--business-platforms-platform--platform-name--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing platform</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/business/platforms/platform/{platform-name}</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing platform</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>platform object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/platform">/platform</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ platform-name
+ </td>
+ <td>
+ <p>Name of the platform</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-platforms-platform--platform-name--"></span>
+ <div id="operation--business-platforms-platform--platform-name--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing platform</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/business/platforms/platform/{platform-name}</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing platform</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ platform-name
+ </td>
+ <td>
+ <p>Name of the platform</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-platforms-platform--platform-name--relationship-list-relationship-"></span>
+ <div id="operation--business-platforms-platform--platform-name--relationship-list-relationship-put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/business/platforms/platform/{platform-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessPlatformsPlatform.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ platform-name
+ </td>
+ <td>
+ <p>Name of the platform</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-platforms-platform--platform-name--relationship-list-relationship-"></span>
+ <div id="operation--business-platforms-platform--platform-name--relationship-list-relationship-delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/business/platforms/platform/{platform-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ platform-name
+ </td>
+ <td>
+ <p>Name of the platform</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-projects-"></span>
+ <div id="operation--business-projects-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns projects</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/business/projects</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns projects</p>
+
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/projects">/projects</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-projects-project--project-name--"></span>
+ <div id="operation--business-projects-project--project-name--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns project</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/business/projects/project/{project-name}</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns project</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ project-name
+ </td>
+ <td>
+ <p>Name of the project deploying a service</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/project">/project</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-projects-project--project-name--"></span>
+ <div id="operation--business-projects-project--project-name--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing project</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/business/projects/project/{project-name}</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing project</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>project object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessProjectsProject.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/project">/project</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ project-name
+ </td>
+ <td>
+ <p>Name of the project deploying a service</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-projects-project--project-name--"></span>
+ <div id="operation--business-projects-project--project-name--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing project</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/business/projects/project/{project-name}</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing project</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>project object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/project">/project</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ project-name
+ </td>
+ <td>
+ <p>Name of the project deploying a service</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-projects-project--project-name--"></span>
+ <div id="operation--business-projects-project--project-name--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing project</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/business/projects/project/{project-name}</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing project</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ project-name
+ </td>
+ <td>
+ <p>Name of the project deploying a service</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-projects-project--project-name--relationship-list-relationship-"></span>
+ <div id="operation--business-projects-project--project-name--relationship-list-relationship-put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/business/projects/project/{project-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessProjectsProject.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ project-name
+ </td>
+ <td>
+ <p>Name of the project deploying a service</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--business-projects-project--project-name--relationship-list-relationship-"></span>
+ <div id="operation--business-projects-project--project-name--relationship-list-relationship-delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/business/projects/project/{project-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Business">Business</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ project-name
+ </td>
+ <td>
+ <p>Name of the project deploying a service</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns cloud-regions</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/cloud-regions</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns cloud-regions</p>
+
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/cloud-regions">/cloud-regions</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns cloud-region</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns cloud-region</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-type
+ </td>
+ <td>
+ <p>Type of the cloud (e.g., openstack)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ owner-defined-type
+ </td>
+ <td>
+ <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/cloud-region">/cloud-region</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing cloud-region</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing cloud-region</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>cloud-region object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegion.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/cloud-region">/cloud-region</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing cloud-region</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing cloud-region</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>cloud-region object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/cloud-region">/cloud-region</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing cloud-region</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing cloud-region</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--availability-zones-"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--availability-zones-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns availability-zones</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns availability-zones</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-type
+ </td>
+ <td>
+ <p>Type of the cloud (e.g., openstack)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ owner-defined-type
+ </td>
+ <td>
+ <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/availability-zones">/availability-zones</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--availability-zones-availability-zone--availability-zone-name--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns availability-zone</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns availability-zone</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ availability-zone-name
+ </td>
+ <td>
+ <p>Name of the availability zone. Unique across a cloud region</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-type
+ </td>
+ <td>
+ <p>Type of the cloud (e.g., openstack)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ owner-defined-type
+ </td>
+ <td>
+ <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/availability-zone">/availability-zone</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--availability-zones-availability-zone--availability-zone-name--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing availability-zone</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing availability-zone</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>availability-zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/availability-zone">/availability-zone</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ availability-zone-name
+ </td>
+ <td>
+ <p>Name of the availability zone. Unique across a cloud region</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--availability-zones-availability-zone--availability-zone-name--"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--availability-zones-availability-zone--availability-zone-name--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing availability-zone</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing availability-zone</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>availability-zone object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/availability-zone">/availability-zone</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ availability-zone-name
+ </td>
+ <td>
+ <p>Name of the availability zone. Unique across a cloud region</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--availability-zones-availability-zone--availability-zone-name--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing availability-zone</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing availability-zone</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ availability-zone-name
+ </td>
+ <td>
+ <p>Name of the availability zone. Unique across a cloud region</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--availability-zones-availability-zone--availability-zone-name--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ availability-zone-name
+ </td>
+ <td>
+ <p>Name of the availability zone. Unique across a cloud region</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--availability-zones-availability-zone--availability-zone-name--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ availability-zone-name
+ </td>
+ <td>
+ <p>Name of the availability zone. Unique across a cloud region</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--dvs-switches-"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--dvs-switches-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns dvs-switches</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns dvs-switches</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-type
+ </td>
+ <td>
+ <p>Type of the cloud (e.g., openstack)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ owner-defined-type
+ </td>
+ <td>
+ <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/dvs-switches">/dvs-switches</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--dvs-switches-dvs-switch--switch-name--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns dvs-switch</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns dvs-switch</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ switch-name
+ </td>
+ <td>
+ <p>DVS switch name</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-type
+ </td>
+ <td>
+ <p>Type of the cloud (e.g., openstack)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ owner-defined-type
+ </td>
+ <td>
+ <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vcenter-url
+ </td>
+ <td>
+ <p>URL used to reach the vcenter</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/dvs-switch">/dvs-switch</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--dvs-switches-dvs-switch--switch-name--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing dvs-switch</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing dvs-switch</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>dvs-switch object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/dvs-switch">/dvs-switch</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ switch-name
+ </td>
+ <td>
+ <p>DVS switch name</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--dvs-switches-dvs-switch--switch-name--"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--dvs-switches-dvs-switch--switch-name--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing dvs-switch</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing dvs-switch</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>dvs-switch object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/dvs-switch">/dvs-switch</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ switch-name
+ </td>
+ <td>
+ <p>DVS switch name</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--dvs-switches-dvs-switch--switch-name--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing dvs-switch</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing dvs-switch</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ switch-name
+ </td>
+ <td>
+ <p>DVS switch name</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--dvs-switches-dvs-switch--switch-name--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ switch-name
+ </td>
+ <td>
+ <p>DVS switch name</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--dvs-switches-dvs-switch--switch-name--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ switch-name
+ </td>
+ <td>
+ <p>DVS switch name</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns flavors</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns flavors</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-type
+ </td>
+ <td>
+ <p>Type of the cloud (e.g., openstack)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ owner-defined-type
+ </td>
+ <td>
+ <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/flavors">/flavors</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns flavor</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns flavor</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ flavor-id
+ </td>
+ <td>
+ <p>Flavor id, expected to be unique across cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-type
+ </td>
+ <td>
+ <p>Type of the cloud (e.g., openstack)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ owner-defined-type
+ </td>
+ <td>
+ <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ flavor-name
+ </td>
+ <td>
+ <p>Flavor name</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/flavor">/flavor</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing flavor</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing flavor</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>flavor object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/flavor">/flavor</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ flavor-id
+ </td>
+ <td>
+ <p>Flavor id, expected to be unique across cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing flavor</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing flavor</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>flavor object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/flavor">/flavor</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ flavor-id
+ </td>
+ <td>
+ <p>Flavor id, expected to be unique across cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing flavor</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing flavor</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ flavor-id
+ </td>
+ <td>
+ <p>Flavor id, expected to be unique across cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ flavor-id
+ </td>
+ <td>
+ <p>Flavor id, expected to be unique across cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ flavor-id
+ </td>
+ <td>
+ <p>Flavor id, expected to be unique across cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--group-assignments-"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--group-assignments-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns group-assignments</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns group-assignments</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-type
+ </td>
+ <td>
+ <p>Type of the cloud (e.g., openstack)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ owner-defined-type
+ </td>
+ <td>
+ <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/group-assignments">/group-assignments</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--group-assignments-group-assignment--group-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns group-assignment</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns group-assignment</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ group-id
+ </td>
+ <td>
+ <p>Group id, expected to be unique across cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-type
+ </td>
+ <td>
+ <p>Type of the cloud (e.g., openstack)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ owner-defined-type
+ </td>
+ <td>
+ <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ group-type
+ </td>
+ <td>
+ <p>Group type - the type of group this instance refers to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ group-name
+ </td>
+ <td>
+ <p>Group name - name assigned to the group</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/group-assignment">/group-assignment</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--group-assignments-group-assignment--group-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing group-assignment</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing group-assignment</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>group-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/group-assignment">/group-assignment</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ group-id
+ </td>
+ <td>
+ <p>Group id, expected to be unique across cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--group-assignments-group-assignment--group-id--"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--group-assignments-group-assignment--group-id--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing group-assignment</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing group-assignment</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>group-assignment object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/group-assignment">/group-assignment</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ group-id
+ </td>
+ <td>
+ <p>Group id, expected to be unique across cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--group-assignments-group-assignment--group-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing group-assignment</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing group-assignment</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ group-id
+ </td>
+ <td>
+ <p>Group id, expected to be unique across cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--group-assignments-group-assignment--group-id--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ group-id
+ </td>
+ <td>
+ <p>Group id, expected to be unique across cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--group-assignments-group-assignment--group-id--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ group-id
+ </td>
+ <td>
+ <p>Group id, expected to be unique across cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--images-"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--images-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns images</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns images</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-type
+ </td>
+ <td>
+ <p>Type of the cloud (e.g., openstack)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ owner-defined-type
+ </td>
+ <td>
+ <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/images">/images</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--images-image--image-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns image</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns image</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ image-id
+ </td>
+ <td>
+ <p>Image id, expected to be unique across cloud region</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-type
+ </td>
+ <td>
+ <p>Type of the cloud (e.g., openstack)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ owner-defined-type
+ </td>
+ <td>
+ <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ image-name
+ </td>
+ <td>
+ <p>Image name</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ application
+ </td>
+ <td>
+ <p>The application that the image instantiates.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ application-vendor
+ </td>
+ <td>
+ <p>The vendor of the application.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ application-version
+ </td>
+ <td>
+ <p>The version of the application.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/image">/image</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--images-image--image-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing image</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing image</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/image">/image</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ image-id
+ </td>
+ <td>
+ <p>Image id, expected to be unique across cloud region</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--images-image--image-id--"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--images-image--image-id--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing image</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing image</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>image object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/image">/image</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ image-id
+ </td>
+ <td>
+ <p>Image id, expected to be unique across cloud region</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--images-image--image-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing image</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing image</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ image-id
+ </td>
+ <td>
+ <p>Image id, expected to be unique across cloud region</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--images-image--image-id--metadata-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns metadata</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns metadata</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ image-id
+ </td>
+ <td>
+ <p>Image id, expected to be unique across cloud region</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-type
+ </td>
+ <td>
+ <p>Type of the cloud (e.g., openstack)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ owner-defined-type
+ </td>
+ <td>
+ <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ image-name
+ </td>
+ <td>
+ <p>Image name</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ application
+ </td>
+ <td>
+ <p>The application that the image instantiates.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ application-vendor
+ </td>
+ <td>
+ <p>The vendor of the application.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ application-version
+ </td>
+ <td>
+ <p>The version of the application.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/metadata">/metadata</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--images-image--image-id--metadata-metadatum--metaname--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns metadatum</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns metadatum</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ image-id
+ </td>
+ <td>
+ <p>Image id, expected to be unique across cloud region</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ metaname
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-type
+ </td>
+ <td>
+ <p>Type of the cloud (e.g., openstack)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ owner-defined-type
+ </td>
+ <td>
+ <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ image-name
+ </td>
+ <td>
+ <p>Image name</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ application
+ </td>
+ <td>
+ <p>The application that the image instantiates.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ application-vendor
+ </td>
+ <td>
+ <p>The vendor of the application.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ application-version
+ </td>
+ <td>
+ <p>The version of the application.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/metadatum">/metadatum</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--images-image--image-id--metadata-metadatum--metaname--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing metadatum</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing metadatum</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/metadatum">/metadatum</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ image-id
+ </td>
+ <td>
+ <p>Image id, expected to be unique across cloud region</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ metaname
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--images-image--image-id--metadata-metadatum--metaname--"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--images-image--image-id--metadata-metadatum--metaname--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing metadatum</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing metadatum</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>metadatum object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/metadatum">/metadatum</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ image-id
+ </td>
+ <td>
+ <p>Image id, expected to be unique across cloud region</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ metaname
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--images-image--image-id--metadata-metadatum--metaname--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing metadatum</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing metadatum</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ image-id
+ </td>
+ <td>
+ <p>Image id, expected to be unique across cloud region</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ metaname
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--images-image--image-id--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ image-id
+ </td>
+ <td>
+ <p>Image id, expected to be unique across cloud region</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--images-image--image-id--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ image-id
+ </td>
+ <td>
+ <p>Image id, expected to be unique across cloud region</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--oam-networks-"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--oam-networks-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns oam-networks</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns oam-networks</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-type
+ </td>
+ <td>
+ <p>Type of the cloud (e.g., openstack)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ owner-defined-type
+ </td>
+ <td>
+ <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/oam-networks">/oam-networks</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--oam-networks-oam-network--network-uuid--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns oam-network</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns oam-network</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-uuid
+ </td>
+ <td>
+ <p>UUID of the network. Unique across a cloud-region</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-type
+ </td>
+ <td>
+ <p>Type of the cloud (e.g., openstack)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ owner-defined-type
+ </td>
+ <td>
+ <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cvlan-tag
+ </td>
+ <td>
+ <p>cvlan-id</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/oam-network">/oam-network</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--oam-networks-oam-network--network-uuid--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing oam-network</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing oam-network</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>oam-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/oam-network">/oam-network</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-uuid
+ </td>
+ <td>
+ <p>UUID of the network. Unique across a cloud-region</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--oam-networks-oam-network--network-uuid--"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--oam-networks-oam-network--network-uuid--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing oam-network</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing oam-network</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>oam-network object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/oam-network">/oam-network</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-uuid
+ </td>
+ <td>
+ <p>UUID of the network. Unique across a cloud-region</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--oam-networks-oam-network--network-uuid--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing oam-network</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing oam-network</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-uuid
+ </td>
+ <td>
+ <p>UUID of the network. Unique across a cloud-region</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--oam-networks-oam-network--network-uuid--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-uuid
+ </td>
+ <td>
+ <p>UUID of the network. Unique across a cloud-region</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--oam-networks-oam-network--network-uuid--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-uuid
+ </td>
+ <td>
+ <p>UUID of the network. Unique across a cloud-region</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--relationship-list-relationship-"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--relationship-list-relationship-put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegion.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--relationship-list-relationship-"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--relationship-list-relationship-delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--snapshots-"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--snapshots-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns snapshots</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns snapshots</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-type
+ </td>
+ <td>
+ <p>Type of the cloud (e.g., openstack)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ owner-defined-type
+ </td>
+ <td>
+ <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/snapshots">/snapshots</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--snapshots-snapshot--snapshot-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns snapshot</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns snapshot</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ snapshot-id
+ </td>
+ <td>
+ <p>Snapshot id, this is the key UUID assoc associated in glance with the snapshots.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-type
+ </td>
+ <td>
+ <p>Type of the cloud (e.g., openstack)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ owner-defined-type
+ </td>
+ <td>
+ <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ snapshot-name
+ </td>
+ <td>
+ <p>Snapshot name</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ application
+ </td>
+ <td>
+ <p>The application that the image instantiates.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ application-vendor
+ </td>
+ <td>
+ <p>The vendor of the application.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ application-version
+ </td>
+ <td>
+ <p>The version of the application.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prev-snapshot-id
+ </td>
+ <td>
+ <p>This field contains the UUID of the previous snapshot (if any).</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/snapshot">/snapshot</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--snapshots-snapshot--snapshot-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing snapshot</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing snapshot</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>snapshot object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/snapshot">/snapshot</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ snapshot-id
+ </td>
+ <td>
+ <p>Snapshot id, this is the key UUID assoc associated in glance with the snapshots.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--snapshots-snapshot--snapshot-id--"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--snapshots-snapshot--snapshot-id--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing snapshot</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing snapshot</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>snapshot object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/snapshot">/snapshot</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ snapshot-id
+ </td>
+ <td>
+ <p>Snapshot id, this is the key UUID assoc associated in glance with the snapshots.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--snapshots-snapshot--snapshot-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing snapshot</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing snapshot</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ snapshot-id
+ </td>
+ <td>
+ <p>Snapshot id, this is the key UUID assoc associated in glance with the snapshots.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--snapshots-snapshot--snapshot-id--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ snapshot-id
+ </td>
+ <td>
+ <p>Snapshot id, this is the key UUID assoc associated in glance with the snapshots.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--snapshots-snapshot--snapshot-id--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ snapshot-id
+ </td>
+ <td>
+ <p>Snapshot id, this is the key UUID assoc associated in glance with the snapshots.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns tenants</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns tenants</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-type
+ </td>
+ <td>
+ <p>Type of the cloud (e.g., openstack)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ owner-defined-type
+ </td>
+ <td>
+ <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/tenants">/tenants</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns tenant</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns tenant</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-type
+ </td>
+ <td>
+ <p>Type of the cloud (e.g., openstack)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ owner-defined-type
+ </td>
+ <td>
+ <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-name
+ </td>
+ <td>
+ <p>Readable name of tenant</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-context
+ </td>
+ <td>
+ <p>This field will store the tenant context.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/tenant">/tenant</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing tenant</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing tenant</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>tenant object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/tenant">/tenant</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing tenant</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing tenant</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>tenant object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/tenant">/tenant</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing tenant</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing tenant</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--vservers-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns vservers</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns vservers</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-type
+ </td>
+ <td>
+ <p>Type of the cloud (e.g., openstack)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ owner-defined-type
+ </td>
+ <td>
+ <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-name
+ </td>
+ <td>
+ <p>Readable name of tenant</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-context
+ </td>
+ <td>
+ <p>This field will store the tenant context.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/vservers">/vservers</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--vservers-vserver--vserver-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns vserver</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns vserver</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-type
+ </td>
+ <td>
+ <p>Type of the cloud (e.g., openstack)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ owner-defined-type
+ </td>
+ <td>
+ <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-name
+ </td>
+ <td>
+ <p>Readable name of tenant</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-context
+ </td>
+ <td>
+ <p>This field will store the tenant context.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-name
+ </td>
+ <td>
+ <p>Name of vserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-name2
+ </td>
+ <td>
+ <p>Alternative name of vserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ is-closed-loop-disabled
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/vserver">/vserver</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--vservers-vserver--vserver-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing vserver</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing vserver</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>vserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/vserver">/vserver</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--vservers-vserver--vserver-id--"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--vservers-vserver--vserver-id--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing vserver</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing vserver</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>vserver object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/vserver">/vserver</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--vservers-vserver--vserver-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing vserver</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing vserver</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--vservers-vserver--vserver-id--l-interfaces-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l-interfaces</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l-interfaces</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-type
+ </td>
+ <td>
+ <p>Type of the cloud (e.g., openstack)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ owner-defined-type
+ </td>
+ <td>
+ <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-name
+ </td>
+ <td>
+ <p>Readable name of tenant</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-context
+ </td>
+ <td>
+ <p>This field will store the tenant context.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-name
+ </td>
+ <td>
+ <p>Name of vserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-name2
+ </td>
+ <td>
+ <p>Alternative name of vserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ is-closed-loop-disabled
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l-interfaces">/l-interfaces</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l-interface</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l-interface</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-type
+ </td>
+ <td>
+ <p>Type of the cloud (e.g., openstack)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ owner-defined-type
+ </td>
+ <td>
+ <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-name
+ </td>
+ <td>
+ <p>Readable name of tenant</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-context
+ </td>
+ <td>
+ <p>This field will store the tenant context.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-name
+ </td>
+ <td>
+ <p>Name of vserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-name2
+ </td>
+ <td>
+ <p>Alternative name of vserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ is-closed-loop-disabled
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l-interface">/l-interface</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l-interface</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l-interface</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l-interface">/l-interface</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l-interface</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l-interface</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l-interface object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l-interface">/l-interface</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l-interface</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l-interface</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-type
+ </td>
+ <td>
+ <p>Type of the cloud (e.g., openstack)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ owner-defined-type
+ </td>
+ <td>
+ <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-name
+ </td>
+ <td>
+ <p>Readable name of tenant</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-context
+ </td>
+ <td>
+ <p>This field will store the tenant context.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-name
+ </td>
+ <td>
+ <p>Name of vserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-name2
+ </td>
+ <td>
+ <p>Alternative name of vserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ is-closed-loop-disabled
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-subnet-id
+ </td>
+ <td>
+ <p>Neutron id of subnet that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv4-address-list object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-type
+ </td>
+ <td>
+ <p>Type of the cloud (e.g., openstack)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ owner-defined-type
+ </td>
+ <td>
+ <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-name
+ </td>
+ <td>
+ <p>Readable name of tenant</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-context
+ </td>
+ <td>
+ <p>This field will store the tenant context.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-name
+ </td>
+ <td>
+ <p>Name of vserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-name2
+ </td>
+ <td>
+ <p>Alternative name of vserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ is-closed-loop-disabled
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-subnet-id
+ </td>
+ <td>
+ <p>Neutron id of subnet that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv6-address-list object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns sriov-vfs</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns sriov-vfs</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-type
+ </td>
+ <td>
+ <p>Type of the cloud (e.g., openstack)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ owner-defined-type
+ </td>
+ <td>
+ <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-name
+ </td>
+ <td>
+ <p>Readable name of tenant</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-context
+ </td>
+ <td>
+ <p>This field will store the tenant context.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-name
+ </td>
+ <td>
+ <p>Name of vserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-name2
+ </td>
+ <td>
+ <p>Alternative name of vserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ is-closed-loop-disabled
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/sriov-vfs">/sriov-vfs</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns sriov-vf</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns sriov-vf</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-type
+ </td>
+ <td>
+ <p>Type of the cloud (e.g., openstack)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ owner-defined-type
+ </td>
+ <td>
+ <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-name
+ </td>
+ <td>
+ <p>Readable name of tenant</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-context
+ </td>
+ <td>
+ <p>This field will store the tenant context.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-name
+ </td>
+ <td>
+ <p>Name of vserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-name2
+ </td>
+ <td>
+ <p>Alternative name of vserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ is-closed-loop-disabled
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vf-vlan-filter
+ </td>
+ <td>
+ <p>This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vf-mac-filter
+ </td>
+ <td>
+ <p>When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vf-vlan-strip
+ </td>
+ <td>
+ <p>When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/sriov-vf">/sriov-vf</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing sriov-vf</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing sriov-vf</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/sriov-vf">/sriov-vf</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing sriov-vf</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing sriov-vf</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>sriov-vf object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/sriov-vf">/sriov-vf</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing sriov-vf</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing sriov-vf</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns vlans</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns vlans</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-type
+ </td>
+ <td>
+ <p>Type of the cloud (e.g., openstack)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ owner-defined-type
+ </td>
+ <td>
+ <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-name
+ </td>
+ <td>
+ <p>Readable name of tenant</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-context
+ </td>
+ <td>
+ <p>This field will store the tenant context.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-name
+ </td>
+ <td>
+ <p>Name of vserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-name2
+ </td>
+ <td>
+ <p>Alternative name of vserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ is-closed-loop-disabled
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/vlans">/vlans</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns vlan</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns vlan</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-type
+ </td>
+ <td>
+ <p>Type of the cloud (e.g., openstack)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ owner-defined-type
+ </td>
+ <td>
+ <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-name
+ </td>
+ <td>
+ <p>Readable name of tenant</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-context
+ </td>
+ <td>
+ <p>This field will store the tenant context.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-name
+ </td>
+ <td>
+ <p>Name of vserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-name2
+ </td>
+ <td>
+ <p>Alternative name of vserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ is-closed-loop-disabled
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vpn-key
+ </td>
+ <td>
+ <p>This indicates the customers VPN ID associated with this vlan</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/vlan">/vlan</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing vlan</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing vlan</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/vlan">/vlan</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing vlan</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing vlan</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>vlan object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/vlan">/vlan</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing vlan</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing vlan</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-type
+ </td>
+ <td>
+ <p>Type of the cloud (e.g., openstack)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ owner-defined-type
+ </td>
+ <td>
+ <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-name
+ </td>
+ <td>
+ <p>Readable name of tenant</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-context
+ </td>
+ <td>
+ <p>This field will store the tenant context.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-name
+ </td>
+ <td>
+ <p>Name of vserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-name2
+ </td>
+ <td>
+ <p>Alternative name of vserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ is-closed-loop-disabled
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vpn-key
+ </td>
+ <td>
+ <p>This indicates the customers VPN ID associated with this vlan</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-subnet-id
+ </td>
+ <td>
+ <p>Neutron id of subnet that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv4-address-list object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-type
+ </td>
+ <td>
+ <p>Type of the cloud (e.g., openstack)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ owner-defined-type
+ </td>
+ <td>
+ <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-name
+ </td>
+ <td>
+ <p>Readable name of tenant</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-context
+ </td>
+ <td>
+ <p>This field will store the tenant context.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-name
+ </td>
+ <td>
+ <p>Name of vserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-name2
+ </td>
+ <td>
+ <p>Alternative name of vserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ is-closed-loop-disabled
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vpn-key
+ </td>
+ <td>
+ <p>This indicates the customers VPN ID associated with this vlan</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-subnet-id
+ </td>
+ <td>
+ <p>Neutron id of subnet that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv6-address-list object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--vservers-vserver--vserver-id--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--vservers-vserver--vserver-id--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--vservers-vserver--vserver-id--volumes-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns volumes</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns volumes</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-type
+ </td>
+ <td>
+ <p>Type of the cloud (e.g., openstack)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ owner-defined-type
+ </td>
+ <td>
+ <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-name
+ </td>
+ <td>
+ <p>Readable name of tenant</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-context
+ </td>
+ <td>
+ <p>This field will store the tenant context.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-name
+ </td>
+ <td>
+ <p>Name of vserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-name2
+ </td>
+ <td>
+ <p>Alternative name of vserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ is-closed-loop-disabled
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/volumes">/volumes</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--vservers-vserver--vserver-id--volumes-volume--volume-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns volume</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns volume</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ volume-id
+ </td>
+ <td>
+ <p>Unique ID of block storage volume relative to the vserver.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-type
+ </td>
+ <td>
+ <p>Type of the cloud (e.g., openstack)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ owner-defined-type
+ </td>
+ <td>
+ <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-name
+ </td>
+ <td>
+ <p>Readable name of tenant</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-context
+ </td>
+ <td>
+ <p>This field will store the tenant context.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-name
+ </td>
+ <td>
+ <p>Name of vserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-name2
+ </td>
+ <td>
+ <p>Alternative name of vserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ is-closed-loop-disabled
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/volume">/volume</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--vservers-vserver--vserver-id--volumes-volume--volume-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing volume</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing volume</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>volume object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/volume">/volume</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ volume-id
+ </td>
+ <td>
+ <p>Unique ID of block storage volume relative to the vserver.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--vservers-vserver--vserver-id--volumes-volume--volume-id--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing volume</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing volume</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>volume object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/volume">/volume</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ volume-id
+ </td>
+ <td>
+ <p>Unique ID of block storage volume relative to the vserver.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--vservers-vserver--vserver-id--volumes-volume--volume-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing volume</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing volume</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ volume-id
+ </td>
+ <td>
+ <p>Unique ID of block storage volume relative to the vserver.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ volume-id
+ </td>
+ <td>
+ <p>Unique ID of block storage volume relative to the vserver.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ tenant-id
+ </td>
+ <td>
+ <p>Unique id relative to the cloud-region.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vserver-id
+ </td>
+ <td>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ volume-id
+ </td>
+ <td>
+ <p>Unique ID of block storage volume relative to the vserver.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv4-address-list--vip-ipv4-address--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns vip-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns vip-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vip-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-type
+ </td>
+ <td>
+ <p>Type of the cloud (e.g., openstack)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ owner-defined-type
+ </td>
+ <td>
+ <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-subnet-id
+ </td>
+ <td>
+ <p>Neutron id of subnet that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/vip-ipv4-address-list">/vip-ipv4-address-list</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv4-address-list--vip-ipv4-address--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing vip-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing vip-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>vip-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/vip-ipv4-address-list">/vip-ipv4-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vip-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv4-address-list--vip-ipv4-address--"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv4-address-list--vip-ipv4-address--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing vip-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing vip-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>vip-ipv4-address-list object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/vip-ipv4-address-list">/vip-ipv4-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vip-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv4-address-list--vip-ipv4-address--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing vip-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing vip-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vip-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv4-address-list--vip-ipv4-address--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vip-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv4-address-list--vip-ipv4-address--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vip-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv6-address-list--vip-ipv6-address--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns vip-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns vip-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vip-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-type
+ </td>
+ <td>
+ <p>Type of the cloud (e.g., openstack)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ owner-defined-type
+ </td>
+ <td>
+ <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-subnet-id
+ </td>
+ <td>
+ <p>Neutron id of subnet that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/vip-ipv6-address-list">/vip-ipv6-address-list</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv6-address-list--vip-ipv6-address--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing vip-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing vip-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>vip-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/vip-ipv6-address-list">/vip-ipv6-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vip-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv6-address-list--vip-ipv6-address--"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv6-address-list--vip-ipv6-address--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing vip-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing vip-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>vip-ipv6-address-list object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/vip-ipv6-address-list">/vip-ipv6-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vip-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv6-address-list--vip-ipv6-address--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing vip-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing vip-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vip-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv6-address-list--vip-ipv6-address--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vip-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv6-address-list--vip-ipv6-address--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vip-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--volume-groups-"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--volume-groups-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns volume-groups</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns volume-groups</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-type
+ </td>
+ <td>
+ <p>Type of the cloud (e.g., openstack)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ owner-defined-type
+ </td>
+ <td>
+ <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/volume-groups">/volume-groups</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--volume-groups-volume-group--volume-group-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns volume-group</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns volume-group</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ volume-group-id
+ </td>
+ <td>
+ <p>Unique ID of volume-group.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-type
+ </td>
+ <td>
+ <p>Type of the cloud (e.g., openstack)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ owner-defined-type
+ </td>
+ <td>
+ <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ volume-group-name
+ </td>
+ <td>
+ <p>Name of the volume group.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this volume-group</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/volume-group">/volume-group</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--volume-groups-volume-group--volume-group-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing volume-group</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing volume-group</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>volume-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/volume-group">/volume-group</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ volume-group-id
+ </td>
+ <td>
+ <p>Unique ID of volume-group.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--volume-groups-volume-group--volume-group-id--"></span>
+ <div id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--volume-groups-volume-group--volume-group-id--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing volume-group</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing volume-group</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>volume-group object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/volume-group">/volume-group</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ volume-group-id
+ </td>
+ <td>
+ <p>Unique ID of volume-group.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--volume-groups-volume-group--volume-group-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing volume-group</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing volume-group</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ volume-group-id
+ </td>
+ <td>
+ <p>Unique ID of volume-group.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--volume-groups-volume-group--volume-group-id--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ volume-group-id
+ </td>
+ <td>
+ <p>Unique ID of volume-group.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--volume-groups-volume-group--volume-group-id--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ cloud-owner
+ </td>
+ <td>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cloud-region-id
+ </td>
+ <td>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ volume-group-id
+ </td>
+ <td>
+ <p>Unique ID of volume-group.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-complexes-"></span>
+ <div id="operation--cloud-infrastructure-complexes-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns complexes</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/complexes</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns complexes</p>
+
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/complexes">/complexes</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-complexes-complex--physical-location-id--"></span>
+ <div id="operation--cloud-infrastructure-complexes-complex--physical-location-id--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns complex</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/complexes/complex/{physical-location-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns complex</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ physical-location-id
+ </td>
+ <td>
+ <p>Unique identifier for physical location, e.g., CLLI</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ data-center-code
+ </td>
+ <td>
+ <p>Data center code which can be an alternate way to identify a complex</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ complex-name
+ </td>
+ <td>
+ <p>Gamma complex name for LCP instance.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ identity-url
+ </td>
+ <td>
+ <p>URL of the keystone identity service</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/complex">/complex</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-complexes-complex--physical-location-id--"></span>
+ <div id="operation--cloud-infrastructure-complexes-complex--physical-location-id--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing complex</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/complexes/complex/{physical-location-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing complex</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>complex object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureComplexesComplex.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/complex">/complex</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ physical-location-id
+ </td>
+ <td>
+ <p>Unique identifier for physical location, e.g., CLLI</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-complexes-complex--physical-location-id--"></span>
+ <div id="operation--cloud-infrastructure-complexes-complex--physical-location-id--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing complex</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/cloud-infrastructure/complexes/complex/{physical-location-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing complex</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>complex object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/complex">/complex</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ physical-location-id
+ </td>
+ <td>
+ <p>Unique identifier for physical location, e.g., CLLI</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-complexes-complex--physical-location-id--"></span>
+ <div id="operation--cloud-infrastructure-complexes-complex--physical-location-id--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing complex</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/complexes/complex/{physical-location-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing complex</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ physical-location-id
+ </td>
+ <td>
+ <p>Unique identifier for physical location, e.g., CLLI</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-complexes-complex--physical-location-id--ctag-pools-"></span>
+ <div id="operation--cloud-infrastructure-complexes-complex--physical-location-id--ctag-pools-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns ctag-pools</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns ctag-pools</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ physical-location-id
+ </td>
+ <td>
+ <p>Unique identifier for physical location, e.g., CLLI</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ data-center-code
+ </td>
+ <td>
+ <p>Data center code which can be an alternate way to identify a complex</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ complex-name
+ </td>
+ <td>
+ <p>Gamma complex name for LCP instance.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ identity-url
+ </td>
+ <td>
+ <p>URL of the keystone identity service</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/ctag-pools">/ctag-pools</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-complexes-complex--physical-location-id--ctag-pools-ctag-pool--target-pe---availability-zone-name--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns ctag-pool</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns ctag-pool</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ physical-location-id
+ </td>
+ <td>
+ <p>Unique identifier for physical location, e.g., CLLI</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ target-pe
+ </td>
+ <td>
+ <p>The Target provider edge router</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ availability-zone-name
+ </td>
+ <td>
+ <p>Name of the availability zone</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ data-center-code
+ </td>
+ <td>
+ <p>Data center code which can be an alternate way to identify a complex</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ complex-name
+ </td>
+ <td>
+ <p>Gamma complex name for LCP instance.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ identity-url
+ </td>
+ <td>
+ <p>URL of the keystone identity service</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/ctag-pool">/ctag-pool</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-complexes-complex--physical-location-id--ctag-pools-ctag-pool--target-pe---availability-zone-name--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing ctag-pool</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing ctag-pool</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>ctag-pool object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/ctag-pool">/ctag-pool</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ physical-location-id
+ </td>
+ <td>
+ <p>Unique identifier for physical location, e.g., CLLI</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ target-pe
+ </td>
+ <td>
+ <p>The Target provider edge router</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ availability-zone-name
+ </td>
+ <td>
+ <p>Name of the availability zone</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-complexes-complex--physical-location-id--ctag-pools-ctag-pool--target-pe---availability-zone-name--"></span>
+ <div id="operation--cloud-infrastructure-complexes-complex--physical-location-id--ctag-pools-ctag-pool--target-pe---availability-zone-name--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing ctag-pool</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing ctag-pool</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>ctag-pool object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/ctag-pool">/ctag-pool</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ physical-location-id
+ </td>
+ <td>
+ <p>Unique identifier for physical location, e.g., CLLI</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ target-pe
+ </td>
+ <td>
+ <p>The Target provider edge router</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ availability-zone-name
+ </td>
+ <td>
+ <p>Name of the availability zone</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-complexes-complex--physical-location-id--ctag-pools-ctag-pool--target-pe---availability-zone-name--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing ctag-pool</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing ctag-pool</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ physical-location-id
+ </td>
+ <td>
+ <p>Unique identifier for physical location, e.g., CLLI</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ target-pe
+ </td>
+ <td>
+ <p>The Target provider edge router</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ availability-zone-name
+ </td>
+ <td>
+ <p>Name of the availability zone</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-complexes-complex--physical-location-id--ctag-pools-ctag-pool--target-pe---availability-zone-name--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ physical-location-id
+ </td>
+ <td>
+ <p>Unique identifier for physical location, e.g., CLLI</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ target-pe
+ </td>
+ <td>
+ <p>The Target provider edge router</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ availability-zone-name
+ </td>
+ <td>
+ <p>Name of the availability zone</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-complexes-complex--physical-location-id--ctag-pools-ctag-pool--target-pe---availability-zone-name--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ physical-location-id
+ </td>
+ <td>
+ <p>Unique identifier for physical location, e.g., CLLI</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ target-pe
+ </td>
+ <td>
+ <p>The Target provider edge router</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ availability-zone-name
+ </td>
+ <td>
+ <p>Name of the availability zone</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-complexes-complex--physical-location-id--relationship-list-relationship-"></span>
+ <div id="operation--cloud-infrastructure-complexes-complex--physical-location-id--relationship-list-relationship-put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/complexes/complex/{physical-location-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureComplexesComplex.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ physical-location-id
+ </td>
+ <td>
+ <p>Unique identifier for physical location, e.g., CLLI</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-complexes-complex--physical-location-id--relationship-list-relationship-"></span>
+ <div id="operation--cloud-infrastructure-complexes-complex--physical-location-id--relationship-list-relationship-delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/complexes/complex/{physical-location-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ physical-location-id
+ </td>
+ <td>
+ <p>Unique identifier for physical location, e.g., CLLI</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-network-profiles-"></span>
+ <div id="operation--cloud-infrastructure-network-profiles-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns network-profiles</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/network-profiles</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns network-profiles</p>
+
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/network-profiles">/network-profiles</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-network-profiles-network-profile--nm-profile-name--"></span>
+ <div id="operation--cloud-infrastructure-network-profiles-network-profile--nm-profile-name--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns network-profile</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns network-profile</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ nm-profile-name
+ </td>
+ <td>
+ <p>Unique name of network profile.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/network-profile">/network-profile</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-network-profiles-network-profile--nm-profile-name--"></span>
+ <div id="operation--cloud-infrastructure-network-profiles-network-profile--nm-profile-name--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing network-profile</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing network-profile</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>network-profile object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureNetworkProfilesNetworkProfile.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/network-profile">/network-profile</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ nm-profile-name
+ </td>
+ <td>
+ <p>Unique name of network profile.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-network-profiles-network-profile--nm-profile-name--"></span>
+ <div id="operation--cloud-infrastructure-network-profiles-network-profile--nm-profile-name--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing network-profile</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing network-profile</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>network-profile object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/network-profile">/network-profile</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ nm-profile-name
+ </td>
+ <td>
+ <p>Unique name of network profile.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-network-profiles-network-profile--nm-profile-name--"></span>
+ <div id="operation--cloud-infrastructure-network-profiles-network-profile--nm-profile-name--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing network-profile</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing network-profile</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ nm-profile-name
+ </td>
+ <td>
+ <p>Unique name of network profile.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-network-profiles-network-profile--nm-profile-name--relationship-list-relationship-"></span>
+ <div id="operation--cloud-infrastructure-network-profiles-network-profile--nm-profile-name--relationship-list-relationship-put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureNetworkProfilesNetworkProfile.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ nm-profile-name
+ </td>
+ <td>
+ <p>Unique name of network profile.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-network-profiles-network-profile--nm-profile-name--relationship-list-relationship-"></span>
+ <div id="operation--cloud-infrastructure-network-profiles-network-profile--nm-profile-name--relationship-list-relationship-delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ nm-profile-name
+ </td>
+ <td>
+ <p>Unique name of network profile.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-operational-environments-"></span>
+ <div id="operation--cloud-infrastructure-operational-environments-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns operational-environments</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/operational-environments</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns operational-environments</p>
+
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/operational-environments">/operational-environments</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-operational-environments-operational-environment--operational-environment-id--"></span>
+ <div id="operation--cloud-infrastructure-operational-environments-operational-environment--operational-environment-id--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns operational-environment</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns operational-environment</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ operational-environment-id
+ </td>
+ <td>
+ <p>UUID of an operational environment</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/operational-environment">/operational-environment</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-operational-environments-operational-environment--operational-environment-id--"></span>
+ <div id="operation--cloud-infrastructure-operational-environments-operational-environment--operational-environment-id--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing operational-environment</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing operational-environment</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>operational-environment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureOperationalEnvironmentsOperationalEnvironment.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/operational-environment">/operational-environment</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ operational-environment-id
+ </td>
+ <td>
+ <p>UUID of an operational environment</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-operational-environments-operational-environment--operational-environment-id--"></span>
+ <div id="operation--cloud-infrastructure-operational-environments-operational-environment--operational-environment-id--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing operational-environment</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing operational-environment</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>operational-environment object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/operational-environment">/operational-environment</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ operational-environment-id
+ </td>
+ <td>
+ <p>UUID of an operational environment</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-operational-environments-operational-environment--operational-environment-id--"></span>
+ <div id="operation--cloud-infrastructure-operational-environments-operational-environment--operational-environment-id--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing operational-environment</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing operational-environment</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ operational-environment-id
+ </td>
+ <td>
+ <p>UUID of an operational environment</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-operational-environments-operational-environment--operational-environment-id--relationship-list-relationship-"></span>
+ <div id="operation--cloud-infrastructure-operational-environments-operational-environment--operational-environment-id--relationship-list-relationship-put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureOperationalEnvironmentsOperationalEnvironment.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ operational-environment-id
+ </td>
+ <td>
+ <p>UUID of an operational environment</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-operational-environments-operational-environment--operational-environment-id--relationship-list-relationship-"></span>
+ <div id="operation--cloud-infrastructure-operational-environments-operational-environment--operational-environment-id--relationship-list-relationship-delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ operational-environment-id
+ </td>
+ <td>
+ <p>UUID of an operational environment</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-"></span>
+ <div id="operation--cloud-infrastructure-pservers-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns pservers</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/pservers</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns pservers</p>
+
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/pservers">/pservers</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--"></span>
+ <div id="operation--cloud-infrastructure-pservers-pserver--hostname--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns pserver</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns pserver</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-id
+ </td>
+ <td>
+ <p>ID of Pserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-name2
+ </td>
+ <td>
+ <p>alternative pserver name</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/pserver">/pserver</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--"></span>
+ <div id="operation--cloud-infrastructure-pservers-pserver--hostname--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing pserver</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing pserver</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>pserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserver.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/pserver">/pserver</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--"></span>
+ <div id="operation--cloud-infrastructure-pservers-pserver--hostname--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing pserver</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing pserver</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>pserver object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/pserver">/pserver</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--"></span>
+ <div id="operation--cloud-infrastructure-pservers-pserver--hostname--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing pserver</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing pserver</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-"></span>
+ <div id="operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns lag-interfaces</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns lag-interfaces</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-id
+ </td>
+ <td>
+ <p>ID of Pserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-name2
+ </td>
+ <td>
+ <p>alternative pserver name</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/lag-interfaces">/lag-interfaces</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--"></span>
+ <div id="operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns lag-interface</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns lag-interface</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-id
+ </td>
+ <td>
+ <p>ID of Pserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-name2
+ </td>
+ <td>
+ <p>alternative pserver name</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-role
+ </td>
+ <td>
+ <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/lag-interface">/lag-interface</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--"></span>
+ <div id="operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing lag-interface</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing lag-interface</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/lag-interface">/lag-interface</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--"></span>
+ <div id="operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing lag-interface</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing lag-interface</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>lag-interface object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/lag-interface">/lag-interface</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--"></span>
+ <div id="operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing lag-interface</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing lag-interface</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-"></span>
+ <div id="operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l-interfaces</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l-interfaces</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-id
+ </td>
+ <td>
+ <p>ID of Pserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-name2
+ </td>
+ <td>
+ <p>alternative pserver name</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-role
+ </td>
+ <td>
+ <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l-interfaces">/l-interfaces</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l-interface</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l-interface</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-id
+ </td>
+ <td>
+ <p>ID of Pserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-name2
+ </td>
+ <td>
+ <p>alternative pserver name</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-role
+ </td>
+ <td>
+ <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l-interface">/l-interface</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l-interface</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l-interface</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l-interface">/l-interface</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--"></span>
+ <div id="operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l-interface</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l-interface</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l-interface object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l-interface">/l-interface</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l-interface</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l-interface</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-id
+ </td>
+ <td>
+ <p>ID of Pserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-name2
+ </td>
+ <td>
+ <p>alternative pserver name</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-role
+ </td>
+ <td>
+ <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-subnet-id
+ </td>
+ <td>
+ <p>Neutron id of subnet that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv4-address-list object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-id
+ </td>
+ <td>
+ <p>ID of Pserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-name2
+ </td>
+ <td>
+ <p>alternative pserver name</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-role
+ </td>
+ <td>
+ <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-subnet-id
+ </td>
+ <td>
+ <p>Neutron id of subnet that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv6-address-list object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns sriov-vfs</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns sriov-vfs</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-id
+ </td>
+ <td>
+ <p>ID of Pserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-name2
+ </td>
+ <td>
+ <p>alternative pserver name</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-role
+ </td>
+ <td>
+ <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/sriov-vfs">/sriov-vfs</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns sriov-vf</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns sriov-vf</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-id
+ </td>
+ <td>
+ <p>ID of Pserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-name2
+ </td>
+ <td>
+ <p>alternative pserver name</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-role
+ </td>
+ <td>
+ <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vf-vlan-filter
+ </td>
+ <td>
+ <p>This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vf-mac-filter
+ </td>
+ <td>
+ <p>When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vf-vlan-strip
+ </td>
+ <td>
+ <p>When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/sriov-vf">/sriov-vf</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing sriov-vf</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing sriov-vf</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/sriov-vf">/sriov-vf</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing sriov-vf</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing sriov-vf</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>sriov-vf object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/sriov-vf">/sriov-vf</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing sriov-vf</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing sriov-vf</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns vlans</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns vlans</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-id
+ </td>
+ <td>
+ <p>ID of Pserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-name2
+ </td>
+ <td>
+ <p>alternative pserver name</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-role
+ </td>
+ <td>
+ <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/vlans">/vlans</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns vlan</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns vlan</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-id
+ </td>
+ <td>
+ <p>ID of Pserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-name2
+ </td>
+ <td>
+ <p>alternative pserver name</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-role
+ </td>
+ <td>
+ <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vpn-key
+ </td>
+ <td>
+ <p>This indicates the customers VPN ID associated with this vlan</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/vlan">/vlan</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing vlan</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing vlan</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/vlan">/vlan</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--"></span>
+ <div id="operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing vlan</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing vlan</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>vlan object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/vlan">/vlan</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing vlan</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing vlan</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-id
+ </td>
+ <td>
+ <p>ID of Pserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-name2
+ </td>
+ <td>
+ <p>alternative pserver name</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-role
+ </td>
+ <td>
+ <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vpn-key
+ </td>
+ <td>
+ <p>This indicates the customers VPN ID associated with this vlan</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-subnet-id
+ </td>
+ <td>
+ <p>Neutron id of subnet that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv4-address-list object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-id
+ </td>
+ <td>
+ <p>ID of Pserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-name2
+ </td>
+ <td>
+ <p>alternative pserver name</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-role
+ </td>
+ <td>
+ <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vpn-key
+ </td>
+ <td>
+ <p>This indicates the customers VPN ID associated with this vlan</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-subnet-id
+ </td>
+ <td>
+ <p>Neutron id of subnet that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv6-address-list object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--relationship-list-relationship-"></span>
+ <div id="operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--relationship-list-relationship-put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--relationship-list-relationship-"></span>
+ <div id="operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--relationship-list-relationship-delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-"></span>
+ <div id="operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns p-interfaces</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns p-interfaces</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-id
+ </td>
+ <td>
+ <p>ID of Pserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-name2
+ </td>
+ <td>
+ <p>alternative pserver name</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/p-interfaces">/p-interfaces</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--"></span>
+ <div id="operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns p-interface</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns p-interface</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-id
+ </td>
+ <td>
+ <p>ID of Pserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-name2
+ </td>
+ <td>
+ <p>alternative pserver name</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/p-interface">/p-interface</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--"></span>
+ <div id="operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing p-interface</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing p-interface</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterface.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/p-interface">/p-interface</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--"></span>
+ <div id="operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing p-interface</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing p-interface</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>p-interface object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/p-interface">/p-interface</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--"></span>
+ <div id="operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing p-interface</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing p-interface</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-"></span>
+ <div id="operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l-interfaces</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l-interfaces</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-id
+ </td>
+ <td>
+ <p>ID of Pserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-name2
+ </td>
+ <td>
+ <p>alternative pserver name</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l-interfaces">/l-interfaces</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l-interface</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l-interface</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-id
+ </td>
+ <td>
+ <p>ID of Pserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-name2
+ </td>
+ <td>
+ <p>alternative pserver name</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l-interface">/l-interface</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l-interface</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l-interface</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l-interface">/l-interface</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--"></span>
+ <div id="operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l-interface</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l-interface</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l-interface object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l-interface">/l-interface</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l-interface</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l-interface</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-id
+ </td>
+ <td>
+ <p>ID of Pserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-name2
+ </td>
+ <td>
+ <p>alternative pserver name</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-subnet-id
+ </td>
+ <td>
+ <p>Neutron id of subnet that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv4-address-list object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-id
+ </td>
+ <td>
+ <p>ID of Pserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-name2
+ </td>
+ <td>
+ <p>alternative pserver name</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-subnet-id
+ </td>
+ <td>
+ <p>Neutron id of subnet that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv6-address-list object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns sriov-vfs</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns sriov-vfs</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-id
+ </td>
+ <td>
+ <p>ID of Pserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-name2
+ </td>
+ <td>
+ <p>alternative pserver name</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/sriov-vfs">/sriov-vfs</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns sriov-vf</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns sriov-vf</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-id
+ </td>
+ <td>
+ <p>ID of Pserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-name2
+ </td>
+ <td>
+ <p>alternative pserver name</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vf-vlan-filter
+ </td>
+ <td>
+ <p>This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vf-mac-filter
+ </td>
+ <td>
+ <p>When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vf-vlan-strip
+ </td>
+ <td>
+ <p>When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/sriov-vf">/sriov-vf</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing sriov-vf</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing sriov-vf</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/sriov-vf">/sriov-vf</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing sriov-vf</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing sriov-vf</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>sriov-vf object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/sriov-vf">/sriov-vf</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing sriov-vf</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing sriov-vf</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns vlans</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns vlans</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-id
+ </td>
+ <td>
+ <p>ID of Pserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-name2
+ </td>
+ <td>
+ <p>alternative pserver name</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/vlans">/vlans</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns vlan</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns vlan</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-id
+ </td>
+ <td>
+ <p>ID of Pserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-name2
+ </td>
+ <td>
+ <p>alternative pserver name</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vpn-key
+ </td>
+ <td>
+ <p>This indicates the customers VPN ID associated with this vlan</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/vlan">/vlan</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing vlan</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing vlan</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/vlan">/vlan</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--"></span>
+ <div id="operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing vlan</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing vlan</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>vlan object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/vlan">/vlan</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing vlan</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing vlan</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-id
+ </td>
+ <td>
+ <p>ID of Pserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-name2
+ </td>
+ <td>
+ <p>alternative pserver name</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vpn-key
+ </td>
+ <td>
+ <p>This indicates the customers VPN ID associated with this vlan</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-subnet-id
+ </td>
+ <td>
+ <p>Neutron id of subnet that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv4-address-list object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-id
+ </td>
+ <td>
+ <p>ID of Pserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-name2
+ </td>
+ <td>
+ <p>alternative pserver name</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vpn-key
+ </td>
+ <td>
+ <p>This indicates the customers VPN ID associated with this vlan</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-subnet-id
+ </td>
+ <td>
+ <p>Neutron id of subnet that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv6-address-list object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--relationship-list-relationship-"></span>
+ <div id="operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--relationship-list-relationship-put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterface.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--relationship-list-relationship-"></span>
+ <div id="operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--relationship-list-relationship-delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--sriov-pfs-"></span>
+ <div id="operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--sriov-pfs-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns sriov-pfs</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns sriov-pfs</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-id
+ </td>
+ <td>
+ <p>ID of Pserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-name2
+ </td>
+ <td>
+ <p>alternative pserver name</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/sriov-pfs">/sriov-pfs</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns sriov-pf</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns sriov-pf</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pf-pci-id
+ </td>
+ <td>
+ <p>Identifier for the sriov-pf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-id
+ </td>
+ <td>
+ <p>ID of Pserver</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pserver-name2
+ </td>
+ <td>
+ <p>alternative pserver name</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/sriov-pf">/sriov-pf</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing sriov-pf</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing sriov-pf</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/sriov-pf">/sriov-pf</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pf-pci-id
+ </td>
+ <td>
+ <p>Identifier for the sriov-pf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--"></span>
+ <div id="operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing sriov-pf</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing sriov-pf</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>sriov-pf object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/sriov-pf">/sriov-pf</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pf-pci-id
+ </td>
+ <td>
+ <p>Identifier for the sriov-pf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing sriov-pf</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing sriov-pf</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pf-pci-id
+ </td>
+ <td>
+ <p>Identifier for the sriov-pf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pf-pci-id
+ </td>
+ <td>
+ <p>Identifier for the sriov-pf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pf-pci-id
+ </td>
+ <td>
+ <p>Identifier for the sriov-pf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--relationship-list-relationship-"></span>
+ <div id="operation--cloud-infrastructure-pservers-pserver--hostname--relationship-list-relationship-put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserver.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-pservers-pserver--hostname--relationship-list-relationship-"></span>
+ <div id="operation--cloud-infrastructure-pservers-pserver--hostname--relationship-list-relationship-delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ hostname
+ </td>
+ <td>
+ <p>Value from executing hostname on the compute node.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-virtual-data-centers-"></span>
+ <div id="operation--cloud-infrastructure-virtual-data-centers-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns virtual-data-centers</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/virtual-data-centers</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns virtual-data-centers</p>
+
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/virtual-data-centers">/virtual-data-centers</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-virtual-data-centers-virtual-data-center--vdc-id--"></span>
+ <div id="operation--cloud-infrastructure-virtual-data-centers-virtual-data-center--vdc-id--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns virtual-data-center</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns virtual-data-center</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vdc-id
+ </td>
+ <td>
+ <p>Unique ID of the vdc</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vdc-name
+ </td>
+ <td>
+ <p>Name of the virtual data center</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/virtual-data-center">/virtual-data-center</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-virtual-data-centers-virtual-data-center--vdc-id--"></span>
+ <div id="operation--cloud-infrastructure-virtual-data-centers-virtual-data-center--vdc-id--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing virtual-data-center</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing virtual-data-center</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>virtual-data-center object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/virtual-data-center">/virtual-data-center</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vdc-id
+ </td>
+ <td>
+ <p>Unique ID of the vdc</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-virtual-data-centers-virtual-data-center--vdc-id--"></span>
+ <div id="operation--cloud-infrastructure-virtual-data-centers-virtual-data-center--vdc-id--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing virtual-data-center</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing virtual-data-center</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>virtual-data-center object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/virtual-data-center">/virtual-data-center</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vdc-id
+ </td>
+ <td>
+ <p>Unique ID of the vdc</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-virtual-data-centers-virtual-data-center--vdc-id--"></span>
+ <div id="operation--cloud-infrastructure-virtual-data-centers-virtual-data-center--vdc-id--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing virtual-data-center</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing virtual-data-center</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vdc-id
+ </td>
+ <td>
+ <p>Unique ID of the vdc</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-virtual-data-centers-virtual-data-center--vdc-id--relationship-list-relationship-"></span>
+ <div id="operation--cloud-infrastructure-virtual-data-centers-virtual-data-center--vdc-id--relationship-list-relationship-put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vdc-id
+ </td>
+ <td>
+ <p>Unique ID of the vdc</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--cloud-infrastructure-virtual-data-centers-virtual-data-center--vdc-id--relationship-list-relationship-"></span>
+ <div id="operation--cloud-infrastructure-virtual-data-centers-virtual-data-center--vdc-id--relationship-list-relationship-delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-CloudInfrastructure">CloudInfrastructure</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vdc-id
+ </td>
+ <td>
+ <p>Unique ID of the vdc</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-configurations-"></span>
+ <div id="operation--network-configurations-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns configurations</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/configurations</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns configurations</p>
+
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/configurations">/configurations</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-configurations-configuration--configuration-id--"></span>
+ <div id="operation--network-configurations-configuration--configuration-id--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns configuration</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/configurations/configuration/{configuration-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns configuration</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ configuration-id
+ </td>
+ <td>
+ <p>UUID assigned to configuration.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/configuration">/configuration</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-configurations-configuration--configuration-id--"></span>
+ <div id="operation--network-configurations-configuration--configuration-id--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing configuration</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/configurations/configuration/{configuration-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing configuration</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfiguration.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/configuration">/configuration</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ configuration-id
+ </td>
+ <td>
+ <p>UUID assigned to configuration.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-configurations-configuration--configuration-id--"></span>
+ <div id="operation--network-configurations-configuration--configuration-id--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing configuration</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/configurations/configuration/{configuration-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing configuration</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>configuration object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/configuration">/configuration</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ configuration-id
+ </td>
+ <td>
+ <p>UUID assigned to configuration.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-configurations-configuration--configuration-id--"></span>
+ <div id="operation--network-configurations-configuration--configuration-id--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing configuration</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/configurations/configuration/{configuration-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing configuration</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ configuration-id
+ </td>
+ <td>
+ <p>UUID assigned to configuration.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-configurations-configuration--configuration-id--evcs-"></span>
+ <div id="operation--network-configurations-configuration--configuration-id--evcs-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns evcs</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/configurations/configuration/{configuration-id}/evcs</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns evcs</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ configuration-id
+ </td>
+ <td>
+ <p>UUID assigned to configuration.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/evcs">/evcs</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-configurations-configuration--configuration-id--evcs-evc--evc-id--"></span>
+ <div id="operation--network-configurations-configuration--configuration-id--evcs-evc--evc-id--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns evc</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns evc</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ configuration-id
+ </td>
+ <td>
+ <p>UUID assigned to configuration.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ evc-id
+ </td>
+ <td>
+ <p>Unique/key field for the evc object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/evc">/evc</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-configurations-configuration--configuration-id--evcs-evc--evc-id--"></span>
+ <div id="operation--network-configurations-configuration--configuration-id--evcs-evc--evc-id--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing evc</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing evc</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>evc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfigurationEvcsEvc.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/evc">/evc</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ configuration-id
+ </td>
+ <td>
+ <p>UUID assigned to configuration.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ evc-id
+ </td>
+ <td>
+ <p>Unique/key field for the evc object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-configurations-configuration--configuration-id--evcs-evc--evc-id--"></span>
+ <div id="operation--network-configurations-configuration--configuration-id--evcs-evc--evc-id--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing evc</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing evc</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>evc object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/evc">/evc</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ configuration-id
+ </td>
+ <td>
+ <p>UUID assigned to configuration.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ evc-id
+ </td>
+ <td>
+ <p>Unique/key field for the evc object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-configurations-configuration--configuration-id--evcs-evc--evc-id--"></span>
+ <div id="operation--network-configurations-configuration--configuration-id--evcs-evc--evc-id--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing evc</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing evc</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ configuration-id
+ </td>
+ <td>
+ <p>UUID assigned to configuration.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ evc-id
+ </td>
+ <td>
+ <p>Unique/key field for the evc object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-configurations-configuration--configuration-id--evcs-evc--evc-id--relationship-list-relationship-"></span>
+ <div id="operation--network-configurations-configuration--configuration-id--evcs-evc--evc-id--relationship-list-relationship-put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfigurationEvcsEvc.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ configuration-id
+ </td>
+ <td>
+ <p>UUID assigned to configuration.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ evc-id
+ </td>
+ <td>
+ <p>Unique/key field for the evc object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-configurations-configuration--configuration-id--evcs-evc--evc-id--relationship-list-relationship-"></span>
+ <div id="operation--network-configurations-configuration--configuration-id--evcs-evc--evc-id--relationship-list-relationship-delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ configuration-id
+ </td>
+ <td>
+ <p>UUID assigned to configuration.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ evc-id
+ </td>
+ <td>
+ <p>Unique/key field for the evc object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-configurations-configuration--configuration-id--forwarder-evcs-"></span>
+ <div id="operation--network-configurations-configuration--configuration-id--forwarder-evcs-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns forwarder-evcs</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/configurations/configuration/{configuration-id}/forwarder-evcs</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns forwarder-evcs</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ configuration-id
+ </td>
+ <td>
+ <p>UUID assigned to configuration.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/forwarder-evcs">/forwarder-evcs</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-configurations-configuration--configuration-id--forwarder-evcs-forwarder-evc--forwarder-evc-id--"></span>
+ <div id="operation--network-configurations-configuration--configuration-id--forwarder-evcs-forwarder-evc--forwarder-evc-id--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns forwarder-evc</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns forwarder-evc</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ configuration-id
+ </td>
+ <td>
+ <p>UUID assigned to configuration.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ forwarder-evc-id
+ </td>
+ <td>
+ <p>Key for forwarder-evc object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/forwarder-evc">/forwarder-evc</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-configurations-configuration--configuration-id--forwarder-evcs-forwarder-evc--forwarder-evc-id--"></span>
+ <div id="operation--network-configurations-configuration--configuration-id--forwarder-evcs-forwarder-evc--forwarder-evc-id--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing forwarder-evc</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing forwarder-evc</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>forwarder-evc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfigurationForwarderEvcsForwarderEvc.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/forwarder-evc">/forwarder-evc</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ configuration-id
+ </td>
+ <td>
+ <p>UUID assigned to configuration.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ forwarder-evc-id
+ </td>
+ <td>
+ <p>Key for forwarder-evc object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-configurations-configuration--configuration-id--forwarder-evcs-forwarder-evc--forwarder-evc-id--"></span>
+ <div id="operation--network-configurations-configuration--configuration-id--forwarder-evcs-forwarder-evc--forwarder-evc-id--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing forwarder-evc</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing forwarder-evc</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>forwarder-evc object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/forwarder-evc">/forwarder-evc</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ configuration-id
+ </td>
+ <td>
+ <p>UUID assigned to configuration.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ forwarder-evc-id
+ </td>
+ <td>
+ <p>Key for forwarder-evc object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-configurations-configuration--configuration-id--forwarder-evcs-forwarder-evc--forwarder-evc-id--"></span>
+ <div id="operation--network-configurations-configuration--configuration-id--forwarder-evcs-forwarder-evc--forwarder-evc-id--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing forwarder-evc</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing forwarder-evc</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ configuration-id
+ </td>
+ <td>
+ <p>UUID assigned to configuration.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ forwarder-evc-id
+ </td>
+ <td>
+ <p>Key for forwarder-evc object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-configurations-configuration--configuration-id--forwarder-evcs-forwarder-evc--forwarder-evc-id--relationship-list-relationship-"></span>
+ <div id="operation--network-configurations-configuration--configuration-id--forwarder-evcs-forwarder-evc--forwarder-evc-id--relationship-list-relationship-put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfigurationForwarderEvcsForwarderEvc.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ configuration-id
+ </td>
+ <td>
+ <p>UUID assigned to configuration.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ forwarder-evc-id
+ </td>
+ <td>
+ <p>Key for forwarder-evc object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-configurations-configuration--configuration-id--forwarder-evcs-forwarder-evc--forwarder-evc-id--relationship-list-relationship-"></span>
+ <div id="operation--network-configurations-configuration--configuration-id--forwarder-evcs-forwarder-evc--forwarder-evc-id--relationship-list-relationship-delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ configuration-id
+ </td>
+ <td>
+ <p>UUID assigned to configuration.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ forwarder-evc-id
+ </td>
+ <td>
+ <p>Key for forwarder-evc object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-configurations-configuration--configuration-id--metadata-"></span>
+ <div id="operation--network-configurations-configuration--configuration-id--metadata-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns metadata</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/configurations/configuration/{configuration-id}/metadata</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns metadata</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ configuration-id
+ </td>
+ <td>
+ <p>UUID assigned to configuration.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/metadata">/metadata</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-configurations-configuration--configuration-id--metadata-metadatum--metaname--"></span>
+ <div id="operation--network-configurations-configuration--configuration-id--metadata-metadatum--metaname--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns metadatum</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns metadatum</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ configuration-id
+ </td>
+ <td>
+ <p>UUID assigned to configuration.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ metaname
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/metadatum">/metadatum</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-configurations-configuration--configuration-id--metadata-metadatum--metaname--"></span>
+ <div id="operation--network-configurations-configuration--configuration-id--metadata-metadatum--metaname--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing metadatum</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing metadatum</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfigurationMetadataMetadatum.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/metadatum">/metadatum</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ configuration-id
+ </td>
+ <td>
+ <p>UUID assigned to configuration.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ metaname
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-configurations-configuration--configuration-id--metadata-metadatum--metaname--"></span>
+ <div id="operation--network-configurations-configuration--configuration-id--metadata-metadatum--metaname--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing metadatum</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing metadatum</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>metadatum object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/metadatum">/metadatum</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ configuration-id
+ </td>
+ <td>
+ <p>UUID assigned to configuration.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ metaname
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-configurations-configuration--configuration-id--metadata-metadatum--metaname--"></span>
+ <div id="operation--network-configurations-configuration--configuration-id--metadata-metadatum--metaname--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing metadatum</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing metadatum</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ configuration-id
+ </td>
+ <td>
+ <p>UUID assigned to configuration.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ metaname
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-configurations-configuration--configuration-id--relationship-list-relationship-"></span>
+ <div id="operation--network-configurations-configuration--configuration-id--relationship-list-relationship-put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/configurations/configuration/{configuration-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfiguration.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ configuration-id
+ </td>
+ <td>
+ <p>UUID assigned to configuration.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-configurations-configuration--configuration-id--relationship-list-relationship-"></span>
+ <div id="operation--network-configurations-configuration--configuration-id--relationship-list-relationship-delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/configurations/configuration/{configuration-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ configuration-id
+ </td>
+ <td>
+ <p>UUID assigned to configuration.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-forwarding-paths-"></span>
+ <div id="operation--network-forwarding-paths-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns forwarding-paths</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/forwarding-paths</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns forwarding-paths</p>
+
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/forwarding-paths">/forwarding-paths</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-forwarding-paths-forwarding-path--forwarding-path-id--"></span>
+ <div id="operation--network-forwarding-paths-forwarding-path--forwarding-path-id--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns forwarding-path</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/forwarding-paths/forwarding-path/{forwarding-path-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns forwarding-path</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ forwarding-path-id
+ </td>
+ <td>
+ <p>Unique ID of this FP</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ forwarding-path-name
+ </td>
+ <td>
+ <p>Name of the FP</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/forwarding-path">/forwarding-path</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-forwarding-paths-forwarding-path--forwarding-path-id--"></span>
+ <div id="operation--network-forwarding-paths-forwarding-path--forwarding-path-id--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing forwarding-path</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/forwarding-paths/forwarding-path/{forwarding-path-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing forwarding-path</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>forwarding-path object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkForwardingPathsForwardingPath.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/forwarding-path">/forwarding-path</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ forwarding-path-id
+ </td>
+ <td>
+ <p>Unique ID of this FP</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-forwarding-paths-forwarding-path--forwarding-path-id--"></span>
+ <div id="operation--network-forwarding-paths-forwarding-path--forwarding-path-id--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing forwarding-path</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/forwarding-paths/forwarding-path/{forwarding-path-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing forwarding-path</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>forwarding-path object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/forwarding-path">/forwarding-path</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ forwarding-path-id
+ </td>
+ <td>
+ <p>Unique ID of this FP</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-forwarding-paths-forwarding-path--forwarding-path-id--"></span>
+ <div id="operation--network-forwarding-paths-forwarding-path--forwarding-path-id--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing forwarding-path</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/forwarding-paths/forwarding-path/{forwarding-path-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing forwarding-path</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ forwarding-path-id
+ </td>
+ <td>
+ <p>Unique ID of this FP</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-forwarding-paths-forwarding-path--forwarding-path-id--forwarders-"></span>
+ <div id="operation--network-forwarding-paths-forwarding-path--forwarding-path-id--forwarders-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns forwarders</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns forwarders</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ forwarding-path-id
+ </td>
+ <td>
+ <p>Unique ID of this FP</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ forwarding-path-name
+ </td>
+ <td>
+ <p>Name of the FP</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/forwarders">/forwarders</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-forwarding-paths-forwarding-path--forwarding-path-id--forwarders-forwarder--sequence--"></span>
+ <div id="operation--network-forwarding-paths-forwarding-path--forwarding-path-id--forwarders-forwarder--sequence--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns forwarder</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns forwarder</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ forwarding-path-id
+ </td>
+ <td>
+ <p>Unique ID of this FP</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ sequence
+ </td>
+ <td>
+ <p>Unique ID of this segmentation</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ forwarding-path-name
+ </td>
+ <td>
+ <p>Name of the FP</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/forwarder">/forwarder</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-forwarding-paths-forwarding-path--forwarding-path-id--forwarders-forwarder--sequence--"></span>
+ <div id="operation--network-forwarding-paths-forwarding-path--forwarding-path-id--forwarders-forwarder--sequence--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing forwarder</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing forwarder</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>forwarder object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkForwardingPathsForwardingPathForwardersForwarder.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/forwarder">/forwarder</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ forwarding-path-id
+ </td>
+ <td>
+ <p>Unique ID of this FP</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ sequence
+ </td>
+ <td>
+ <p>Unique ID of this segmentation</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-forwarding-paths-forwarding-path--forwarding-path-id--forwarders-forwarder--sequence--"></span>
+ <div id="operation--network-forwarding-paths-forwarding-path--forwarding-path-id--forwarders-forwarder--sequence--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing forwarder</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing forwarder</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>forwarder object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/forwarder">/forwarder</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ forwarding-path-id
+ </td>
+ <td>
+ <p>Unique ID of this FP</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ sequence
+ </td>
+ <td>
+ <p>Unique ID of this segmentation</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-forwarding-paths-forwarding-path--forwarding-path-id--forwarders-forwarder--sequence--"></span>
+ <div id="operation--network-forwarding-paths-forwarding-path--forwarding-path-id--forwarders-forwarder--sequence--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing forwarder</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing forwarder</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ forwarding-path-id
+ </td>
+ <td>
+ <p>Unique ID of this FP</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ sequence
+ </td>
+ <td>
+ <p>Unique ID of this segmentation</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-forwarding-paths-forwarding-path--forwarding-path-id--forwarders-forwarder--sequence--relationship-list-relationship-"></span>
+ <div id="operation--network-forwarding-paths-forwarding-path--forwarding-path-id--forwarders-forwarder--sequence--relationship-list-relationship-put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkForwardingPathsForwardingPathForwardersForwarder.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ forwarding-path-id
+ </td>
+ <td>
+ <p>Unique ID of this FP</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ sequence
+ </td>
+ <td>
+ <p>Unique ID of this segmentation</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-forwarding-paths-forwarding-path--forwarding-path-id--forwarders-forwarder--sequence--relationship-list-relationship-"></span>
+ <div id="operation--network-forwarding-paths-forwarding-path--forwarding-path-id--forwarders-forwarder--sequence--relationship-list-relationship-delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ forwarding-path-id
+ </td>
+ <td>
+ <p>Unique ID of this FP</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ sequence
+ </td>
+ <td>
+ <p>Unique ID of this segmentation</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-forwarding-paths-forwarding-path--forwarding-path-id--relationship-list-relationship-"></span>
+ <div id="operation--network-forwarding-paths-forwarding-path--forwarding-path-id--relationship-list-relationship-put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/forwarding-paths/forwarding-path/{forwarding-path-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkForwardingPathsForwardingPath.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ forwarding-path-id
+ </td>
+ <td>
+ <p>Unique ID of this FP</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-forwarding-paths-forwarding-path--forwarding-path-id--relationship-list-relationship-"></span>
+ <div id="operation--network-forwarding-paths-forwarding-path--forwarding-path-id--relationship-list-relationship-delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/forwarding-paths/forwarding-path/{forwarding-path-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ forwarding-path-id
+ </td>
+ <td>
+ <p>Unique ID of this FP</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-"></span>
+ <div id="operation--network-generic-vnfs-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns generic-vnfs</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/generic-vnfs</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns generic-vnfs</p>
+
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/generic-vnfs">/generic-vnfs</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--"></span>
+ <div id="operation--network-generic-vnfs-generic-vnf--vnf-id--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns generic-vnf</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns generic-vnf</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name
+ </td>
+ <td>
+ <p>Name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name2
+ </td>
+ <td>
+ <p>Alternate name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ regional-resource-zone
+ </td>
+ <td>
+ <p>Regional way of organizing pservers, source of truth should define values</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ is-closed-loop-disabled
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-id
+ </td>
+ <td>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-version
+ </td>
+ <td>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-type
+ </td>
+ <td>
+ <p>Generic description of the type of NF</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-function
+ </td>
+ <td>
+ <p>English description of Network function that the specific VNF deployment is providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-role
+ </td>
+ <td>
+ <p>role in the network that this model will be providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-naming-code
+ </td>
+ <td>
+ <p>string assigned to this model used for naming purposes</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/generic-vnf">/generic-vnf</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--"></span>
+ <div id="operation--network-generic-vnfs-generic-vnf--vnf-id--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing generic-vnf</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing generic-vnf</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>generic-vnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnf.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/generic-vnf">/generic-vnf</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--"></span>
+ <div id="operation--network-generic-vnfs-generic-vnf--vnf-id--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing generic-vnf</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing generic-vnf</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>generic-vnf object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/generic-vnf">/generic-vnf</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--"></span>
+ <div id="operation--network-generic-vnfs-generic-vnf--vnf-id--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing generic-vnf</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing generic-vnf</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--entitlements-"></span>
+ <div id="operation--network-generic-vnfs-generic-vnf--vnf-id--entitlements-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns entitlements</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/entitlements</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns entitlements</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name
+ </td>
+ <td>
+ <p>Name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name2
+ </td>
+ <td>
+ <p>Alternate name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ regional-resource-zone
+ </td>
+ <td>
+ <p>Regional way of organizing pservers, source of truth should define values</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ is-closed-loop-disabled
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-id
+ </td>
+ <td>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-version
+ </td>
+ <td>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-type
+ </td>
+ <td>
+ <p>Generic description of the type of NF</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-function
+ </td>
+ <td>
+ <p>English description of Network function that the specific VNF deployment is providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-role
+ </td>
+ <td>
+ <p>role in the network that this model will be providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-naming-code
+ </td>
+ <td>
+ <p>string assigned to this model used for naming purposes</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/entitlements">/entitlements</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--entitlements-entitlement--group-uuid---resource-uuid--"></span>
+ <div id="operation--network-generic-vnfs-generic-vnf--vnf-id--entitlements-entitlement--group-uuid---resource-uuid--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns entitlement</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns entitlement</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ group-uuid
+ </td>
+ <td>
+ <p>Unique ID for the entitlement group the resource comes from, should be uuid.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-uuid
+ </td>
+ <td>
+ <p>Unique ID of an entitlement resource.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name
+ </td>
+ <td>
+ <p>Name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name2
+ </td>
+ <td>
+ <p>Alternate name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ regional-resource-zone
+ </td>
+ <td>
+ <p>Regional way of organizing pservers, source of truth should define values</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ is-closed-loop-disabled
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-id
+ </td>
+ <td>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-version
+ </td>
+ <td>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-type
+ </td>
+ <td>
+ <p>Generic description of the type of NF</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-function
+ </td>
+ <td>
+ <p>English description of Network function that the specific VNF deployment is providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-role
+ </td>
+ <td>
+ <p>role in the network that this model will be providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-naming-code
+ </td>
+ <td>
+ <p>string assigned to this model used for naming purposes</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/entitlement">/entitlement</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--entitlements-entitlement--group-uuid---resource-uuid--"></span>
+ <div id="operation--network-generic-vnfs-generic-vnf--vnf-id--entitlements-entitlement--group-uuid---resource-uuid--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing entitlement</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing entitlement</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/entitlement">/entitlement</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ group-uuid
+ </td>
+ <td>
+ <p>Unique ID for the entitlement group the resource comes from, should be uuid.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-uuid
+ </td>
+ <td>
+ <p>Unique ID of an entitlement resource.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--entitlements-entitlement--group-uuid---resource-uuid--"></span>
+ <div id="operation--network-generic-vnfs-generic-vnf--vnf-id--entitlements-entitlement--group-uuid---resource-uuid--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing entitlement</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing entitlement</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>entitlement object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/entitlement">/entitlement</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ group-uuid
+ </td>
+ <td>
+ <p>Unique ID for the entitlement group the resource comes from, should be uuid.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-uuid
+ </td>
+ <td>
+ <p>Unique ID of an entitlement resource.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--entitlements-entitlement--group-uuid---resource-uuid--"></span>
+ <div id="operation--network-generic-vnfs-generic-vnf--vnf-id--entitlements-entitlement--group-uuid---resource-uuid--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing entitlement</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing entitlement</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ group-uuid
+ </td>
+ <td>
+ <p>Unique ID for the entitlement group the resource comes from, should be uuid.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-uuid
+ </td>
+ <td>
+ <p>Unique ID of an entitlement resource.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--entitlements-entitlement--group-uuid---resource-uuid--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ group-uuid
+ </td>
+ <td>
+ <p>Unique ID for the entitlement group the resource comes from, should be uuid.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-uuid
+ </td>
+ <td>
+ <p>Unique ID of an entitlement resource.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--entitlements-entitlement--group-uuid---resource-uuid--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ group-uuid
+ </td>
+ <td>
+ <p>Unique ID for the entitlement group the resource comes from, should be uuid.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-uuid
+ </td>
+ <td>
+ <p>Unique ID of an entitlement resource.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-"></span>
+ <div id="operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l-interfaces</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l-interfaces</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name
+ </td>
+ <td>
+ <p>Name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name2
+ </td>
+ <td>
+ <p>Alternate name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ regional-resource-zone
+ </td>
+ <td>
+ <p>Regional way of organizing pservers, source of truth should define values</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ is-closed-loop-disabled
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-id
+ </td>
+ <td>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-version
+ </td>
+ <td>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-type
+ </td>
+ <td>
+ <p>Generic description of the type of NF</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-function
+ </td>
+ <td>
+ <p>English description of Network function that the specific VNF deployment is providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-role
+ </td>
+ <td>
+ <p>role in the network that this model will be providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-naming-code
+ </td>
+ <td>
+ <p>string assigned to this model used for naming purposes</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l-interfaces">/l-interfaces</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--"></span>
+ <div id="operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l-interface</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l-interface</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name
+ </td>
+ <td>
+ <p>Name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name2
+ </td>
+ <td>
+ <p>Alternate name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ regional-resource-zone
+ </td>
+ <td>
+ <p>Regional way of organizing pservers, source of truth should define values</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ is-closed-loop-disabled
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-id
+ </td>
+ <td>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-version
+ </td>
+ <td>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-type
+ </td>
+ <td>
+ <p>Generic description of the type of NF</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-function
+ </td>
+ <td>
+ <p>English description of Network function that the specific VNF deployment is providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-role
+ </td>
+ <td>
+ <p>role in the network that this model will be providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-naming-code
+ </td>
+ <td>
+ <p>string assigned to this model used for naming purposes</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l-interface">/l-interface</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--"></span>
+ <div id="operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l-interface</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l-interface</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l-interface">/l-interface</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--"></span>
+ <div id="operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l-interface</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l-interface</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l-interface object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l-interface">/l-interface</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--"></span>
+ <div id="operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l-interface</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l-interface</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--l3-interface-ipv4-address-list--l3-interface-ipv4-address--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name
+ </td>
+ <td>
+ <p>Name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name2
+ </td>
+ <td>
+ <p>Alternate name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ regional-resource-zone
+ </td>
+ <td>
+ <p>Regional way of organizing pservers, source of truth should define values</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ is-closed-loop-disabled
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-id
+ </td>
+ <td>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-version
+ </td>
+ <td>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-type
+ </td>
+ <td>
+ <p>Generic description of the type of NF</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-function
+ </td>
+ <td>
+ <p>English description of Network function that the specific VNF deployment is providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-role
+ </td>
+ <td>
+ <p>role in the network that this model will be providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-naming-code
+ </td>
+ <td>
+ <p>string assigned to this model used for naming purposes</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-subnet-id
+ </td>
+ <td>
+ <p>Neutron id of subnet that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--l3-interface-ipv4-address-list--l3-interface-ipv4-address--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--l3-interface-ipv4-address-list--l3-interface-ipv4-address--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv4-address-list object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--l3-interface-ipv4-address-list--l3-interface-ipv4-address--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--l3-interface-ipv6-address-list--l3-interface-ipv6-address--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name
+ </td>
+ <td>
+ <p>Name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name2
+ </td>
+ <td>
+ <p>Alternate name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ regional-resource-zone
+ </td>
+ <td>
+ <p>Regional way of organizing pservers, source of truth should define values</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ is-closed-loop-disabled
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-id
+ </td>
+ <td>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-version
+ </td>
+ <td>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-type
+ </td>
+ <td>
+ <p>Generic description of the type of NF</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-function
+ </td>
+ <td>
+ <p>English description of Network function that the specific VNF deployment is providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-role
+ </td>
+ <td>
+ <p>role in the network that this model will be providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-naming-code
+ </td>
+ <td>
+ <p>string assigned to this model used for naming purposes</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-subnet-id
+ </td>
+ <td>
+ <p>Neutron id of subnet that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--l3-interface-ipv6-address-list--l3-interface-ipv6-address--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--l3-interface-ipv6-address-list--l3-interface-ipv6-address--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv6-address-list object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--l3-interface-ipv6-address-list--l3-interface-ipv6-address--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--sriov-vfs-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns sriov-vfs</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns sriov-vfs</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name
+ </td>
+ <td>
+ <p>Name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name2
+ </td>
+ <td>
+ <p>Alternate name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ regional-resource-zone
+ </td>
+ <td>
+ <p>Regional way of organizing pservers, source of truth should define values</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ is-closed-loop-disabled
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-id
+ </td>
+ <td>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-version
+ </td>
+ <td>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-type
+ </td>
+ <td>
+ <p>Generic description of the type of NF</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-function
+ </td>
+ <td>
+ <p>English description of Network function that the specific VNF deployment is providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-role
+ </td>
+ <td>
+ <p>role in the network that this model will be providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-naming-code
+ </td>
+ <td>
+ <p>string assigned to this model used for naming purposes</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/sriov-vfs">/sriov-vfs</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns sriov-vf</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns sriov-vf</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name
+ </td>
+ <td>
+ <p>Name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name2
+ </td>
+ <td>
+ <p>Alternate name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ regional-resource-zone
+ </td>
+ <td>
+ <p>Regional way of organizing pservers, source of truth should define values</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ is-closed-loop-disabled
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-id
+ </td>
+ <td>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-version
+ </td>
+ <td>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-type
+ </td>
+ <td>
+ <p>Generic description of the type of NF</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-function
+ </td>
+ <td>
+ <p>English description of Network function that the specific VNF deployment is providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-role
+ </td>
+ <td>
+ <p>role in the network that this model will be providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-naming-code
+ </td>
+ <td>
+ <p>string assigned to this model used for naming purposes</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vf-vlan-filter
+ </td>
+ <td>
+ <p>This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vf-mac-filter
+ </td>
+ <td>
+ <p>When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vf-vlan-strip
+ </td>
+ <td>
+ <p>When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/sriov-vf">/sriov-vf</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing sriov-vf</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing sriov-vf</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/sriov-vf">/sriov-vf</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--"></span>
+ <div id="operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing sriov-vf</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing sriov-vf</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>sriov-vf object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/sriov-vf">/sriov-vf</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing sriov-vf</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing sriov-vf</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--vlans-"></span>
+ <div id="operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--vlans-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns vlans</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns vlans</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name
+ </td>
+ <td>
+ <p>Name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name2
+ </td>
+ <td>
+ <p>Alternate name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ regional-resource-zone
+ </td>
+ <td>
+ <p>Regional way of organizing pservers, source of truth should define values</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ is-closed-loop-disabled
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-id
+ </td>
+ <td>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-version
+ </td>
+ <td>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-type
+ </td>
+ <td>
+ <p>Generic description of the type of NF</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-function
+ </td>
+ <td>
+ <p>English description of Network function that the specific VNF deployment is providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-role
+ </td>
+ <td>
+ <p>role in the network that this model will be providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-naming-code
+ </td>
+ <td>
+ <p>string assigned to this model used for naming purposes</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/vlans">/vlans</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns vlan</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns vlan</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name
+ </td>
+ <td>
+ <p>Name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name2
+ </td>
+ <td>
+ <p>Alternate name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ regional-resource-zone
+ </td>
+ <td>
+ <p>Regional way of organizing pservers, source of truth should define values</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ is-closed-loop-disabled
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-id
+ </td>
+ <td>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-version
+ </td>
+ <td>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-type
+ </td>
+ <td>
+ <p>Generic description of the type of NF</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-function
+ </td>
+ <td>
+ <p>English description of Network function that the specific VNF deployment is providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-role
+ </td>
+ <td>
+ <p>role in the network that this model will be providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-naming-code
+ </td>
+ <td>
+ <p>string assigned to this model used for naming purposes</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vpn-key
+ </td>
+ <td>
+ <p>This indicates the customers VPN ID associated with this vlan</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/vlan">/vlan</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing vlan</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing vlan</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/vlan">/vlan</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--"></span>
+ <div id="operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing vlan</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing vlan</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>vlan object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/vlan">/vlan</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing vlan</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing vlan</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name
+ </td>
+ <td>
+ <p>Name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name2
+ </td>
+ <td>
+ <p>Alternate name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ regional-resource-zone
+ </td>
+ <td>
+ <p>Regional way of organizing pservers, source of truth should define values</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ is-closed-loop-disabled
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-id
+ </td>
+ <td>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-version
+ </td>
+ <td>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-type
+ </td>
+ <td>
+ <p>Generic description of the type of NF</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-function
+ </td>
+ <td>
+ <p>English description of Network function that the specific VNF deployment is providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-role
+ </td>
+ <td>
+ <p>role in the network that this model will be providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-naming-code
+ </td>
+ <td>
+ <p>string assigned to this model used for naming purposes</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vpn-key
+ </td>
+ <td>
+ <p>This indicates the customers VPN ID associated with this vlan</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-subnet-id
+ </td>
+ <td>
+ <p>Neutron id of subnet that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv4-address-list object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name
+ </td>
+ <td>
+ <p>Name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name2
+ </td>
+ <td>
+ <p>Alternate name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ regional-resource-zone
+ </td>
+ <td>
+ <p>Regional way of organizing pservers, source of truth should define values</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ is-closed-loop-disabled
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-id
+ </td>
+ <td>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-version
+ </td>
+ <td>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-type
+ </td>
+ <td>
+ <p>Generic description of the type of NF</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-function
+ </td>
+ <td>
+ <p>English description of Network function that the specific VNF deployment is providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-role
+ </td>
+ <td>
+ <p>role in the network that this model will be providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-naming-code
+ </td>
+ <td>
+ <p>string assigned to this model used for naming purposes</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vpn-key
+ </td>
+ <td>
+ <p>This indicates the customers VPN ID associated with this vlan</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-subnet-id
+ </td>
+ <td>
+ <p>Neutron id of subnet that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv6-address-list object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-"></span>
+ <div id="operation--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns lag-interfaces</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns lag-interfaces</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name
+ </td>
+ <td>
+ <p>Name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name2
+ </td>
+ <td>
+ <p>Alternate name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ regional-resource-zone
+ </td>
+ <td>
+ <p>Regional way of organizing pservers, source of truth should define values</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ is-closed-loop-disabled
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-id
+ </td>
+ <td>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-version
+ </td>
+ <td>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-type
+ </td>
+ <td>
+ <p>Generic description of the type of NF</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-function
+ </td>
+ <td>
+ <p>English description of Network function that the specific VNF deployment is providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-role
+ </td>
+ <td>
+ <p>role in the network that this model will be providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-naming-code
+ </td>
+ <td>
+ <p>string assigned to this model used for naming purposes</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/lag-interfaces">/lag-interfaces</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--"></span>
+ <div id="operation--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns lag-interface</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns lag-interface</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name
+ </td>
+ <td>
+ <p>Name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name2
+ </td>
+ <td>
+ <p>Alternate name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ regional-resource-zone
+ </td>
+ <td>
+ <p>Regional way of organizing pservers, source of truth should define values</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ is-closed-loop-disabled
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-id
+ </td>
+ <td>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-version
+ </td>
+ <td>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-type
+ </td>
+ <td>
+ <p>Generic description of the type of NF</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-function
+ </td>
+ <td>
+ <p>English description of Network function that the specific VNF deployment is providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-role
+ </td>
+ <td>
+ <p>role in the network that this model will be providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-naming-code
+ </td>
+ <td>
+ <p>string assigned to this model used for naming purposes</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-role
+ </td>
+ <td>
+ <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/lag-interface">/lag-interface</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--"></span>
+ <div id="operation--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing lag-interface</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing lag-interface</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/lag-interface">/lag-interface</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--"></span>
+ <div id="operation--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing lag-interface</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing lag-interface</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>lag-interface object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/lag-interface">/lag-interface</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--"></span>
+ <div id="operation--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing lag-interface</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing lag-interface</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--l-interfaces-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l-interfaces</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l-interfaces</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name
+ </td>
+ <td>
+ <p>Name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name2
+ </td>
+ <td>
+ <p>Alternate name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ regional-resource-zone
+ </td>
+ <td>
+ <p>Regional way of organizing pservers, source of truth should define values</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ is-closed-loop-disabled
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-id
+ </td>
+ <td>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-version
+ </td>
+ <td>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-type
+ </td>
+ <td>
+ <p>Generic description of the type of NF</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-function
+ </td>
+ <td>
+ <p>English description of Network function that the specific VNF deployment is providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-role
+ </td>
+ <td>
+ <p>role in the network that this model will be providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-naming-code
+ </td>
+ <td>
+ <p>string assigned to this model used for naming purposes</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-role
+ </td>
+ <td>
+ <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l-interfaces">/l-interfaces</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l-interface</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l-interface</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name
+ </td>
+ <td>
+ <p>Name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name2
+ </td>
+ <td>
+ <p>Alternate name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ regional-resource-zone
+ </td>
+ <td>
+ <p>Regional way of organizing pservers, source of truth should define values</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ is-closed-loop-disabled
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-id
+ </td>
+ <td>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-version
+ </td>
+ <td>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-type
+ </td>
+ <td>
+ <p>Generic description of the type of NF</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-function
+ </td>
+ <td>
+ <p>English description of Network function that the specific VNF deployment is providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-role
+ </td>
+ <td>
+ <p>role in the network that this model will be providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-naming-code
+ </td>
+ <td>
+ <p>string assigned to this model used for naming purposes</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-role
+ </td>
+ <td>
+ <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l-interface">/l-interface</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l-interface</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l-interface</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l-interface">/l-interface</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--"></span>
+ <div id="operation--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l-interface</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l-interface</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l-interface object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l-interface">/l-interface</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l-interface</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l-interface</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name
+ </td>
+ <td>
+ <p>Name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name2
+ </td>
+ <td>
+ <p>Alternate name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ regional-resource-zone
+ </td>
+ <td>
+ <p>Regional way of organizing pservers, source of truth should define values</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ is-closed-loop-disabled
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-id
+ </td>
+ <td>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-version
+ </td>
+ <td>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-type
+ </td>
+ <td>
+ <p>Generic description of the type of NF</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-function
+ </td>
+ <td>
+ <p>English description of Network function that the specific VNF deployment is providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-role
+ </td>
+ <td>
+ <p>role in the network that this model will be providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-naming-code
+ </td>
+ <td>
+ <p>string assigned to this model used for naming purposes</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-role
+ </td>
+ <td>
+ <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-subnet-id
+ </td>
+ <td>
+ <p>Neutron id of subnet that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv4-address-list object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name
+ </td>
+ <td>
+ <p>Name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name2
+ </td>
+ <td>
+ <p>Alternate name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ regional-resource-zone
+ </td>
+ <td>
+ <p>Regional way of organizing pservers, source of truth should define values</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ is-closed-loop-disabled
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-id
+ </td>
+ <td>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-version
+ </td>
+ <td>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-type
+ </td>
+ <td>
+ <p>Generic description of the type of NF</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-function
+ </td>
+ <td>
+ <p>English description of Network function that the specific VNF deployment is providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-role
+ </td>
+ <td>
+ <p>role in the network that this model will be providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-naming-code
+ </td>
+ <td>
+ <p>string assigned to this model used for naming purposes</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-role
+ </td>
+ <td>
+ <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-subnet-id
+ </td>
+ <td>
+ <p>Neutron id of subnet that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv6-address-list object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns sriov-vfs</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns sriov-vfs</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name
+ </td>
+ <td>
+ <p>Name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name2
+ </td>
+ <td>
+ <p>Alternate name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ regional-resource-zone
+ </td>
+ <td>
+ <p>Regional way of organizing pservers, source of truth should define values</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ is-closed-loop-disabled
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-id
+ </td>
+ <td>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-version
+ </td>
+ <td>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-type
+ </td>
+ <td>
+ <p>Generic description of the type of NF</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-function
+ </td>
+ <td>
+ <p>English description of Network function that the specific VNF deployment is providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-role
+ </td>
+ <td>
+ <p>role in the network that this model will be providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-naming-code
+ </td>
+ <td>
+ <p>string assigned to this model used for naming purposes</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-role
+ </td>
+ <td>
+ <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/sriov-vfs">/sriov-vfs</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns sriov-vf</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns sriov-vf</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name
+ </td>
+ <td>
+ <p>Name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name2
+ </td>
+ <td>
+ <p>Alternate name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ regional-resource-zone
+ </td>
+ <td>
+ <p>Regional way of organizing pservers, source of truth should define values</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ is-closed-loop-disabled
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-id
+ </td>
+ <td>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-version
+ </td>
+ <td>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-type
+ </td>
+ <td>
+ <p>Generic description of the type of NF</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-function
+ </td>
+ <td>
+ <p>English description of Network function that the specific VNF deployment is providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-role
+ </td>
+ <td>
+ <p>role in the network that this model will be providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-naming-code
+ </td>
+ <td>
+ <p>string assigned to this model used for naming purposes</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-role
+ </td>
+ <td>
+ <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vf-vlan-filter
+ </td>
+ <td>
+ <p>This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vf-mac-filter
+ </td>
+ <td>
+ <p>When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vf-vlan-strip
+ </td>
+ <td>
+ <p>When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/sriov-vf">/sriov-vf</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing sriov-vf</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing sriov-vf</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/sriov-vf">/sriov-vf</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing sriov-vf</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing sriov-vf</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>sriov-vf object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/sriov-vf">/sriov-vf</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing sriov-vf</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing sriov-vf</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns vlans</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns vlans</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name
+ </td>
+ <td>
+ <p>Name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name2
+ </td>
+ <td>
+ <p>Alternate name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ regional-resource-zone
+ </td>
+ <td>
+ <p>Regional way of organizing pservers, source of truth should define values</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ is-closed-loop-disabled
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-id
+ </td>
+ <td>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-version
+ </td>
+ <td>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-type
+ </td>
+ <td>
+ <p>Generic description of the type of NF</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-function
+ </td>
+ <td>
+ <p>English description of Network function that the specific VNF deployment is providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-role
+ </td>
+ <td>
+ <p>role in the network that this model will be providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-naming-code
+ </td>
+ <td>
+ <p>string assigned to this model used for naming purposes</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-role
+ </td>
+ <td>
+ <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/vlans">/vlans</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns vlan</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns vlan</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name
+ </td>
+ <td>
+ <p>Name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name2
+ </td>
+ <td>
+ <p>Alternate name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ regional-resource-zone
+ </td>
+ <td>
+ <p>Regional way of organizing pservers, source of truth should define values</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ is-closed-loop-disabled
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-id
+ </td>
+ <td>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-version
+ </td>
+ <td>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-type
+ </td>
+ <td>
+ <p>Generic description of the type of NF</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-function
+ </td>
+ <td>
+ <p>English description of Network function that the specific VNF deployment is providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-role
+ </td>
+ <td>
+ <p>role in the network that this model will be providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-naming-code
+ </td>
+ <td>
+ <p>string assigned to this model used for naming purposes</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-role
+ </td>
+ <td>
+ <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vpn-key
+ </td>
+ <td>
+ <p>This indicates the customers VPN ID associated with this vlan</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/vlan">/vlan</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing vlan</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing vlan</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/vlan">/vlan</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing vlan</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing vlan</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>vlan object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/vlan">/vlan</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing vlan</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing vlan</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name
+ </td>
+ <td>
+ <p>Name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name2
+ </td>
+ <td>
+ <p>Alternate name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ regional-resource-zone
+ </td>
+ <td>
+ <p>Regional way of organizing pservers, source of truth should define values</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ is-closed-loop-disabled
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-id
+ </td>
+ <td>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-version
+ </td>
+ <td>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-type
+ </td>
+ <td>
+ <p>Generic description of the type of NF</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-function
+ </td>
+ <td>
+ <p>English description of Network function that the specific VNF deployment is providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-role
+ </td>
+ <td>
+ <p>role in the network that this model will be providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-naming-code
+ </td>
+ <td>
+ <p>string assigned to this model used for naming purposes</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-role
+ </td>
+ <td>
+ <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vpn-key
+ </td>
+ <td>
+ <p>This indicates the customers VPN ID associated with this vlan</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-subnet-id
+ </td>
+ <td>
+ <p>Neutron id of subnet that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv4-address-list object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name
+ </td>
+ <td>
+ <p>Name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name2
+ </td>
+ <td>
+ <p>Alternate name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ regional-resource-zone
+ </td>
+ <td>
+ <p>Regional way of organizing pservers, source of truth should define values</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ is-closed-loop-disabled
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-id
+ </td>
+ <td>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-version
+ </td>
+ <td>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-type
+ </td>
+ <td>
+ <p>Generic description of the type of NF</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-function
+ </td>
+ <td>
+ <p>English description of Network function that the specific VNF deployment is providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-role
+ </td>
+ <td>
+ <p>role in the network that this model will be providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-naming-code
+ </td>
+ <td>
+ <p>string assigned to this model used for naming purposes</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-role
+ </td>
+ <td>
+ <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vpn-key
+ </td>
+ <td>
+ <p>This indicates the customers VPN ID associated with this vlan</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-subnet-id
+ </td>
+ <td>
+ <p>Neutron id of subnet that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv6-address-list object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--licenses-"></span>
+ <div id="operation--network-generic-vnfs-generic-vnf--vnf-id--licenses-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns licenses</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/licenses</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns licenses</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name
+ </td>
+ <td>
+ <p>Name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name2
+ </td>
+ <td>
+ <p>Alternate name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ regional-resource-zone
+ </td>
+ <td>
+ <p>Regional way of organizing pservers, source of truth should define values</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ is-closed-loop-disabled
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-id
+ </td>
+ <td>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-version
+ </td>
+ <td>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-type
+ </td>
+ <td>
+ <p>Generic description of the type of NF</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-function
+ </td>
+ <td>
+ <p>English description of Network function that the specific VNF deployment is providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-role
+ </td>
+ <td>
+ <p>role in the network that this model will be providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-naming-code
+ </td>
+ <td>
+ <p>string assigned to this model used for naming purposes</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/licenses">/licenses</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--licenses-license--group-uuid---resource-uuid--"></span>
+ <div id="operation--network-generic-vnfs-generic-vnf--vnf-id--licenses-license--group-uuid---resource-uuid--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns license</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns license</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ group-uuid
+ </td>
+ <td>
+ <p>Unique ID for the license group the resource belongs to, should be uuid.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-uuid
+ </td>
+ <td>
+ <p>Unique ID of a license resource.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name
+ </td>
+ <td>
+ <p>Name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name2
+ </td>
+ <td>
+ <p>Alternate name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ regional-resource-zone
+ </td>
+ <td>
+ <p>Regional way of organizing pservers, source of truth should define values</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ is-closed-loop-disabled
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-id
+ </td>
+ <td>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-version
+ </td>
+ <td>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-type
+ </td>
+ <td>
+ <p>Generic description of the type of NF</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-function
+ </td>
+ <td>
+ <p>English description of Network function that the specific VNF deployment is providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-role
+ </td>
+ <td>
+ <p>role in the network that this model will be providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-naming-code
+ </td>
+ <td>
+ <p>string assigned to this model used for naming purposes</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/license">/license</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--licenses-license--group-uuid---resource-uuid--"></span>
+ <div id="operation--network-generic-vnfs-generic-vnf--vnf-id--licenses-license--group-uuid---resource-uuid--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing license</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing license</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLicensesLicense.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/license">/license</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ group-uuid
+ </td>
+ <td>
+ <p>Unique ID for the license group the resource belongs to, should be uuid.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-uuid
+ </td>
+ <td>
+ <p>Unique ID of a license resource.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--licenses-license--group-uuid---resource-uuid--"></span>
+ <div id="operation--network-generic-vnfs-generic-vnf--vnf-id--licenses-license--group-uuid---resource-uuid--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing license</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing license</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>license object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/license">/license</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ group-uuid
+ </td>
+ <td>
+ <p>Unique ID for the license group the resource belongs to, should be uuid.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-uuid
+ </td>
+ <td>
+ <p>Unique ID of a license resource.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--licenses-license--group-uuid---resource-uuid--"></span>
+ <div id="operation--network-generic-vnfs-generic-vnf--vnf-id--licenses-license--group-uuid---resource-uuid--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing license</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing license</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ group-uuid
+ </td>
+ <td>
+ <p>Unique ID for the license group the resource belongs to, should be uuid.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-uuid
+ </td>
+ <td>
+ <p>Unique ID of a license resource.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--licenses-license--group-uuid---resource-uuid--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLicensesLicense.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ group-uuid
+ </td>
+ <td>
+ <p>Unique ID for the license group the resource belongs to, should be uuid.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-uuid
+ </td>
+ <td>
+ <p>Unique ID of a license resource.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--licenses-license--group-uuid---resource-uuid--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ group-uuid
+ </td>
+ <td>
+ <p>Unique ID for the license group the resource belongs to, should be uuid.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-uuid
+ </td>
+ <td>
+ <p>Unique ID of a license resource.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--relationship-list-relationship-"></span>
+ <div id="operation--network-generic-vnfs-generic-vnf--vnf-id--relationship-list-relationship-put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnf.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--relationship-list-relationship-"></span>
+ <div id="operation--network-generic-vnfs-generic-vnf--vnf-id--relationship-list-relationship-delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--vf-modules-"></span>
+ <div id="operation--network-generic-vnfs-generic-vnf--vnf-id--vf-modules-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns vf-modules</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns vf-modules</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name
+ </td>
+ <td>
+ <p>Name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name2
+ </td>
+ <td>
+ <p>Alternate name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ regional-resource-zone
+ </td>
+ <td>
+ <p>Regional way of organizing pservers, source of truth should define values</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ is-closed-loop-disabled
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-id
+ </td>
+ <td>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-version
+ </td>
+ <td>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-type
+ </td>
+ <td>
+ <p>Generic description of the type of NF</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-function
+ </td>
+ <td>
+ <p>English description of Network function that the specific VNF deployment is providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-role
+ </td>
+ <td>
+ <p>role in the network that this model will be providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-naming-code
+ </td>
+ <td>
+ <p>string assigned to this model used for naming purposes</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/vf-modules">/vf-modules</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--vf-modules-vf-module--vf-module-id--"></span>
+ <div id="operation--network-generic-vnfs-generic-vnf--vnf-id--vf-modules-vf-module--vf-module-id--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns vf-module</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns vf-module</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vf-module-id
+ </td>
+ <td>
+ <p>Unique ID of vf-module.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name
+ </td>
+ <td>
+ <p>Name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name2
+ </td>
+ <td>
+ <p>Alternate name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ regional-resource-zone
+ </td>
+ <td>
+ <p>Regional way of organizing pservers, source of truth should define values</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ is-closed-loop-disabled
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-id
+ </td>
+ <td>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-version
+ </td>
+ <td>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-type
+ </td>
+ <td>
+ <p>Generic description of the type of NF</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-function
+ </td>
+ <td>
+ <p>English description of Network function that the specific VNF deployment is providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-role
+ </td>
+ <td>
+ <p>role in the network that this model will be providing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nf-naming-code
+ </td>
+ <td>
+ <p>string assigned to this model used for naming purposes</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vf-module-name
+ </td>
+ <td>
+ <p>Name of vf-module</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-id
+ </td>
+ <td>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-version
+ </td>
+ <td>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ contrail-service-instance-fqdn
+ </td>
+ <td>
+ <p>the Contrail unique ID for a service-instance</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/vf-module">/vf-module</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--vf-modules-vf-module--vf-module-id--"></span>
+ <div id="operation--network-generic-vnfs-generic-vnf--vnf-id--vf-modules-vf-module--vf-module-id--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing vf-module</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing vf-module</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>vf-module object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/vf-module">/vf-module</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vf-module-id
+ </td>
+ <td>
+ <p>Unique ID of vf-module.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--vf-modules-vf-module--vf-module-id--"></span>
+ <div id="operation--network-generic-vnfs-generic-vnf--vnf-id--vf-modules-vf-module--vf-module-id--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing vf-module</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing vf-module</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>vf-module object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/vf-module">/vf-module</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vf-module-id
+ </td>
+ <td>
+ <p>Unique ID of vf-module.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--vf-modules-vf-module--vf-module-id--"></span>
+ <div id="operation--network-generic-vnfs-generic-vnf--vnf-id--vf-modules-vf-module--vf-module-id--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing vf-module</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing vf-module</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vf-module-id
+ </td>
+ <td>
+ <p>Unique ID of vf-module.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--vf-modules-vf-module--vf-module-id--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vf-module-id
+ </td>
+ <td>
+ <p>Unique ID of vf-module.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-generic-vnfs-generic-vnf--vnf-id--vf-modules-vf-module--vf-module-id--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vf-module-id
+ </td>
+ <td>
+ <p>Unique ID of vf-module.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-instance-groups-"></span>
+ <div id="operation--network-instance-groups-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns instance-groups</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/instance-groups</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns instance-groups</p>
+
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/instance-groups">/instance-groups</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-instance-groups-instance-group--id--"></span>
+ <div id="operation--network-instance-groups-instance-group--id--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns instance-group</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/instance-groups/instance-group/{id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns instance-group</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ id
+ </td>
+ <td>
+ <p>Instance Group ID, UUID assigned to this instance.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ description
+ </td>
+ <td>
+ <p>Descriptive text to help identify the usage of this instance-group</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ type
+ </td>
+ <td>
+ <p>Only valid value today is lower case ha for high availability</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ sub-type
+ </td>
+ <td>
+ <p>Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/instance-group">/instance-group</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-instance-groups-instance-group--id--"></span>
+ <div id="operation--network-instance-groups-instance-group--id--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing instance-group</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/instance-groups/instance-group/{id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing instance-group</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>instance-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkInstanceGroupsInstanceGroup.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/instance-group">/instance-group</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ id
+ </td>
+ <td>
+ <p>Instance Group ID, UUID assigned to this instance.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-instance-groups-instance-group--id--"></span>
+ <div id="operation--network-instance-groups-instance-group--id--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing instance-group</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/instance-groups/instance-group/{id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing instance-group</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>instance-group object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/instance-group">/instance-group</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ id
+ </td>
+ <td>
+ <p>Instance Group ID, UUID assigned to this instance.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-instance-groups-instance-group--id--"></span>
+ <div id="operation--network-instance-groups-instance-group--id--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing instance-group</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/instance-groups/instance-group/{id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing instance-group</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ id
+ </td>
+ <td>
+ <p>Instance Group ID, UUID assigned to this instance.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-instance-groups-instance-group--id--relationship-list-relationship-"></span>
+ <div id="operation--network-instance-groups-instance-group--id--relationship-list-relationship-put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/instance-groups/instance-group/{id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkInstanceGroupsInstanceGroup.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ id
+ </td>
+ <td>
+ <p>Instance Group ID, UUID assigned to this instance.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-instance-groups-instance-group--id--relationship-list-relationship-"></span>
+ <div id="operation--network-instance-groups-instance-group--id--relationship-list-relationship-delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/instance-groups/instance-group/{id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ id
+ </td>
+ <td>
+ <p>Instance Group ID, UUID assigned to this instance.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-ipsec-configurations-"></span>
+ <div id="operation--network-ipsec-configurations-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns ipsec-configurations</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/ipsec-configurations</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns ipsec-configurations</p>
+
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/ipsec-configurations">/ipsec-configurations</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-ipsec-configurations-ipsec-configuration--ipsec-configuration-id--"></span>
+ <div id="operation--network-ipsec-configurations-ipsec-configuration--ipsec-configuration-id--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns ipsec-configuration</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns ipsec-configuration</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ ipsec-configuration-id
+ </td>
+ <td>
+ <p>UUID of this configuration</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/ipsec-configuration">/ipsec-configuration</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-ipsec-configurations-ipsec-configuration--ipsec-configuration-id--"></span>
+ <div id="operation--network-ipsec-configurations-ipsec-configuration--ipsec-configuration-id--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing ipsec-configuration</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing ipsec-configuration</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>ipsec-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkIpsecConfigurationsIpsecConfiguration.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/ipsec-configuration">/ipsec-configuration</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ ipsec-configuration-id
+ </td>
+ <td>
+ <p>UUID of this configuration</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-ipsec-configurations-ipsec-configuration--ipsec-configuration-id--"></span>
+ <div id="operation--network-ipsec-configurations-ipsec-configuration--ipsec-configuration-id--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing ipsec-configuration</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing ipsec-configuration</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>ipsec-configuration object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/ipsec-configuration">/ipsec-configuration</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ ipsec-configuration-id
+ </td>
+ <td>
+ <p>UUID of this configuration</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-ipsec-configurations-ipsec-configuration--ipsec-configuration-id--"></span>
+ <div id="operation--network-ipsec-configurations-ipsec-configuration--ipsec-configuration-id--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing ipsec-configuration</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing ipsec-configuration</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ ipsec-configuration-id
+ </td>
+ <td>
+ <p>UUID of this configuration</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-ipsec-configurations-ipsec-configuration--ipsec-configuration-id--relationship-list-relationship-"></span>
+ <div id="operation--network-ipsec-configurations-ipsec-configuration--ipsec-configuration-id--relationship-list-relationship-put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkIpsecConfigurationsIpsecConfiguration.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ ipsec-configuration-id
+ </td>
+ <td>
+ <p>UUID of this configuration</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-ipsec-configurations-ipsec-configuration--ipsec-configuration-id--relationship-list-relationship-"></span>
+ <div id="operation--network-ipsec-configurations-ipsec-configuration--ipsec-configuration-id--relationship-list-relationship-delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ ipsec-configuration-id
+ </td>
+ <td>
+ <p>UUID of this configuration</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-ipsec-configurations-ipsec-configuration--ipsec-configuration-id--vig-servers-"></span>
+ <div id="operation--network-ipsec-configurations-ipsec-configuration--ipsec-configuration-id--vig-servers-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns vig-servers</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns vig-servers</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ ipsec-configuration-id
+ </td>
+ <td>
+ <p>UUID of this configuration</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/vig-servers">/vig-servers</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-ipsec-configurations-ipsec-configuration--ipsec-configuration-id--vig-servers-vig-server--vig-address-type--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns vig-server</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns vig-server</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ ipsec-configuration-id
+ </td>
+ <td>
+ <p>UUID of this configuration</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vig-address-type
+ </td>
+ <td>
+ <p>indicates whether the VIG is for AVPN or INTERNET</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/vig-server">/vig-server</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-ipsec-configurations-ipsec-configuration--ipsec-configuration-id--vig-servers-vig-server--vig-address-type--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing vig-server</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing vig-server</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>vig-server object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/vig-server">/vig-server</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ ipsec-configuration-id
+ </td>
+ <td>
+ <p>UUID of this configuration</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vig-address-type
+ </td>
+ <td>
+ <p>indicates whether the VIG is for AVPN or INTERNET</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-ipsec-configurations-ipsec-configuration--ipsec-configuration-id--vig-servers-vig-server--vig-address-type--"></span>
+ <div id="operation--network-ipsec-configurations-ipsec-configuration--ipsec-configuration-id--vig-servers-vig-server--vig-address-type--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing vig-server</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing vig-server</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>vig-server object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/vig-server">/vig-server</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ ipsec-configuration-id
+ </td>
+ <td>
+ <p>UUID of this configuration</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vig-address-type
+ </td>
+ <td>
+ <p>indicates whether the VIG is for AVPN or INTERNET</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-ipsec-configurations-ipsec-configuration--ipsec-configuration-id--vig-servers-vig-server--vig-address-type--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing vig-server</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing vig-server</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ ipsec-configuration-id
+ </td>
+ <td>
+ <p>UUID of this configuration</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vig-address-type
+ </td>
+ <td>
+ <p>indicates whether the VIG is for AVPN or INTERNET</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-ipsec-configurations-ipsec-configuration--ipsec-configuration-id--vig-servers-vig-server--vig-address-type--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ ipsec-configuration-id
+ </td>
+ <td>
+ <p>UUID of this configuration</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vig-address-type
+ </td>
+ <td>
+ <p>indicates whether the VIG is for AVPN or INTERNET</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-ipsec-configurations-ipsec-configuration--ipsec-configuration-id--vig-servers-vig-server--vig-address-type--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ ipsec-configuration-id
+ </td>
+ <td>
+ <p>UUID of this configuration</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vig-address-type
+ </td>
+ <td>
+ <p>indicates whether the VIG is for AVPN or INTERNET</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-l3-networks-"></span>
+ <div id="operation--network-l3-networks-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l3-networks</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/l3-networks</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l3-networks</p>
+
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l3-networks">/l3-networks</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-l3-networks-l3-network--network-id--"></span>
+ <div id="operation--network-l3-networks-l3-network--network-id--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l3-network</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/l3-networks/l3-network/{network-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l3-network</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ network-id
+ </td>
+ <td>
+ <p>Network ID, should be uuid. Unique across A&AI.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network, governed by some naming convention..</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-role
+ </td>
+ <td>
+ <p>Role the network plans - who defines these values?</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ contrail-network-fqdn
+ </td>
+ <td>
+ <p>Contrail FQDN for the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-id
+ </td>
+ <td>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-version
+ </td>
+ <td>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l3-network">/l3-network</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-l3-networks-l3-network--network-id--"></span>
+ <div id="operation--network-l3-networks-l3-network--network-id--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l3-network</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/l3-networks/l3-network/{network-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l3-network</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3Network.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l3-network">/l3-network</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ network-id
+ </td>
+ <td>
+ <p>Network ID, should be uuid. Unique across A&AI.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-l3-networks-l3-network--network-id--"></span>
+ <div id="operation--network-l3-networks-l3-network--network-id--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l3-network</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/l3-networks/l3-network/{network-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l3-network</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-network object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l3-network">/l3-network</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ network-id
+ </td>
+ <td>
+ <p>Network ID, should be uuid. Unique across A&AI.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-l3-networks-l3-network--network-id--"></span>
+ <div id="operation--network-l3-networks-l3-network--network-id--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l3-network</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/l3-networks/l3-network/{network-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l3-network</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ network-id
+ </td>
+ <td>
+ <p>Network ID, should be uuid. Unique across A&AI.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-l3-networks-l3-network--network-id--ctag-assignments-"></span>
+ <div id="operation--network-l3-networks-l3-network--network-id--ctag-assignments-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns ctag-assignments</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/l3-networks/l3-network/{network-id}/ctag-assignments</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns ctag-assignments</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ network-id
+ </td>
+ <td>
+ <p>Network ID, should be uuid. Unique across A&AI.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network, governed by some naming convention..</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-role
+ </td>
+ <td>
+ <p>Role the network plans - who defines these values?</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ contrail-network-fqdn
+ </td>
+ <td>
+ <p>Contrail FQDN for the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-id
+ </td>
+ <td>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-version
+ </td>
+ <td>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/ctag-assignments">/ctag-assignments</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-l3-networks-l3-network--network-id--ctag-assignments-ctag-assignment--vlan-id-inner--"></span>
+ <div id="operation--network-l3-networks-l3-network--network-id--ctag-assignments-ctag-assignment--vlan-id-inner--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns ctag-assignment</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns ctag-assignment</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ network-id
+ </td>
+ <td>
+ <p>Network ID, should be uuid. Unique across A&AI.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>id.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network, governed by some naming convention..</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-role
+ </td>
+ <td>
+ <p>Role the network plans - who defines these values?</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ contrail-network-fqdn
+ </td>
+ <td>
+ <p>Contrail FQDN for the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-id
+ </td>
+ <td>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-version
+ </td>
+ <td>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/ctag-assignment">/ctag-assignment</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-l3-networks-l3-network--network-id--ctag-assignments-ctag-assignment--vlan-id-inner--"></span>
+ <div id="operation--network-l3-networks-l3-network--network-id--ctag-assignments-ctag-assignment--vlan-id-inner--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing ctag-assignment</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing ctag-assignment</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>ctag-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/ctag-assignment">/ctag-assignment</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ network-id
+ </td>
+ <td>
+ <p>Network ID, should be uuid. Unique across A&AI.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>id.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-l3-networks-l3-network--network-id--ctag-assignments-ctag-assignment--vlan-id-inner--"></span>
+ <div id="operation--network-l3-networks-l3-network--network-id--ctag-assignments-ctag-assignment--vlan-id-inner--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing ctag-assignment</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing ctag-assignment</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>ctag-assignment object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/ctag-assignment">/ctag-assignment</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ network-id
+ </td>
+ <td>
+ <p>Network ID, should be uuid. Unique across A&AI.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>id.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-l3-networks-l3-network--network-id--ctag-assignments-ctag-assignment--vlan-id-inner--"></span>
+ <div id="operation--network-l3-networks-l3-network--network-id--ctag-assignments-ctag-assignment--vlan-id-inner--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing ctag-assignment</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing ctag-assignment</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ network-id
+ </td>
+ <td>
+ <p>Network ID, should be uuid. Unique across A&AI.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>id.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-l3-networks-l3-network--network-id--ctag-assignments-ctag-assignment--vlan-id-inner--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ network-id
+ </td>
+ <td>
+ <p>Network ID, should be uuid. Unique across A&AI.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>id.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-l3-networks-l3-network--network-id--ctag-assignments-ctag-assignment--vlan-id-inner--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ network-id
+ </td>
+ <td>
+ <p>Network ID, should be uuid. Unique across A&AI.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>id.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-l3-networks-l3-network--network-id--relationship-list-relationship-"></span>
+ <div id="operation--network-l3-networks-l3-network--network-id--relationship-list-relationship-put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/l3-networks/l3-network/{network-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3Network.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ network-id
+ </td>
+ <td>
+ <p>Network ID, should be uuid. Unique across A&AI.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-l3-networks-l3-network--network-id--relationship-list-relationship-"></span>
+ <div id="operation--network-l3-networks-l3-network--network-id--relationship-list-relationship-delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/l3-networks/l3-network/{network-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ network-id
+ </td>
+ <td>
+ <p>Network ID, should be uuid. Unique across A&AI.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-l3-networks-l3-network--network-id--segmentation-assignments-"></span>
+ <div id="operation--network-l3-networks-l3-network--network-id--segmentation-assignments-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns segmentation-assignments</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/l3-networks/l3-network/{network-id}/segmentation-assignments</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns segmentation-assignments</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ network-id
+ </td>
+ <td>
+ <p>Network ID, should be uuid. Unique across A&AI.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network, governed by some naming convention..</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-role
+ </td>
+ <td>
+ <p>Role the network plans - who defines these values?</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ contrail-network-fqdn
+ </td>
+ <td>
+ <p>Contrail FQDN for the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-id
+ </td>
+ <td>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-version
+ </td>
+ <td>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/segmentation-assignments">/segmentation-assignments</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-l3-networks-l3-network--network-id--segmentation-assignments-segmentation-assignment--segmentation-id--"></span>
+ <div id="operation--network-l3-networks-l3-network--network-id--segmentation-assignments-segmentation-assignment--segmentation-id--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns segmentation-assignment</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns segmentation-assignment</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ network-id
+ </td>
+ <td>
+ <p>Network ID, should be uuid. Unique across A&AI.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ segmentation-id
+ </td>
+ <td>
+ <p>Route Table Reference id, UUID assigned to this instance.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network, governed by some naming convention..</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-role
+ </td>
+ <td>
+ <p>Role the network plans - who defines these values?</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ contrail-network-fqdn
+ </td>
+ <td>
+ <p>Contrail FQDN for the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-id
+ </td>
+ <td>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-version
+ </td>
+ <td>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/segmentation-assignment">/segmentation-assignment</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-l3-networks-l3-network--network-id--segmentation-assignments-segmentation-assignment--segmentation-id--"></span>
+ <div id="operation--network-l3-networks-l3-network--network-id--segmentation-assignments-segmentation-assignment--segmentation-id--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing segmentation-assignment</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing segmentation-assignment</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>segmentation-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/segmentation-assignment">/segmentation-assignment</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ network-id
+ </td>
+ <td>
+ <p>Network ID, should be uuid. Unique across A&AI.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ segmentation-id
+ </td>
+ <td>
+ <p>Route Table Reference id, UUID assigned to this instance.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-l3-networks-l3-network--network-id--segmentation-assignments-segmentation-assignment--segmentation-id--"></span>
+ <div id="operation--network-l3-networks-l3-network--network-id--segmentation-assignments-segmentation-assignment--segmentation-id--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing segmentation-assignment</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing segmentation-assignment</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>segmentation-assignment object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/segmentation-assignment">/segmentation-assignment</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ network-id
+ </td>
+ <td>
+ <p>Network ID, should be uuid. Unique across A&AI.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ segmentation-id
+ </td>
+ <td>
+ <p>Route Table Reference id, UUID assigned to this instance.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-l3-networks-l3-network--network-id--segmentation-assignments-segmentation-assignment--segmentation-id--"></span>
+ <div id="operation--network-l3-networks-l3-network--network-id--segmentation-assignments-segmentation-assignment--segmentation-id--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing segmentation-assignment</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing segmentation-assignment</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ network-id
+ </td>
+ <td>
+ <p>Network ID, should be uuid. Unique across A&AI.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ segmentation-id
+ </td>
+ <td>
+ <p>Route Table Reference id, UUID assigned to this instance.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-l3-networks-l3-network--network-id--segmentation-assignments-segmentation-assignment--segmentation-id--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ network-id
+ </td>
+ <td>
+ <p>Network ID, should be uuid. Unique across A&AI.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ segmentation-id
+ </td>
+ <td>
+ <p>Route Table Reference id, UUID assigned to this instance.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-l3-networks-l3-network--network-id--segmentation-assignments-segmentation-assignment--segmentation-id--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ network-id
+ </td>
+ <td>
+ <p>Network ID, should be uuid. Unique across A&AI.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ segmentation-id
+ </td>
+ <td>
+ <p>Route Table Reference id, UUID assigned to this instance.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-l3-networks-l3-network--network-id--subnets-"></span>
+ <div id="operation--network-l3-networks-l3-network--network-id--subnets-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns subnets</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/l3-networks/l3-network/{network-id}/subnets</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns subnets</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ network-id
+ </td>
+ <td>
+ <p>Network ID, should be uuid. Unique across A&AI.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network, governed by some naming convention..</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-role
+ </td>
+ <td>
+ <p>Role the network plans - who defines these values?</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ contrail-network-fqdn
+ </td>
+ <td>
+ <p>Contrail FQDN for the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-id
+ </td>
+ <td>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-version
+ </td>
+ <td>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/subnets">/subnets</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-l3-networks-l3-network--network-id--subnets-subnet--subnet-id--"></span>
+ <div id="operation--network-l3-networks-l3-network--network-id--subnets-subnet--subnet-id--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns subnet</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns subnet</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ network-id
+ </td>
+ <td>
+ <p>Network ID, should be uuid. Unique across A&AI.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ subnet-id
+ </td>
+ <td>
+ <p>Subnet ID, should be UUID.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network, governed by some naming convention..</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-role
+ </td>
+ <td>
+ <p>Role the network plans - who defines these values?</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ contrail-network-fqdn
+ </td>
+ <td>
+ <p>Contrail FQDN for the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-id
+ </td>
+ <td>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-version
+ </td>
+ <td>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ subnet-name
+ </td>
+ <td>
+ <p>Name associated with the subnet.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/subnet">/subnet</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-l3-networks-l3-network--network-id--subnets-subnet--subnet-id--"></span>
+ <div id="operation--network-l3-networks-l3-network--network-id--subnets-subnet--subnet-id--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing subnet</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing subnet</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>subnet object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkSubnetsSubnet.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/subnet">/subnet</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ network-id
+ </td>
+ <td>
+ <p>Network ID, should be uuid. Unique across A&AI.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ subnet-id
+ </td>
+ <td>
+ <p>Subnet ID, should be UUID.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-l3-networks-l3-network--network-id--subnets-subnet--subnet-id--"></span>
+ <div id="operation--network-l3-networks-l3-network--network-id--subnets-subnet--subnet-id--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing subnet</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing subnet</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>subnet object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/subnet">/subnet</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ network-id
+ </td>
+ <td>
+ <p>Network ID, should be uuid. Unique across A&AI.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ subnet-id
+ </td>
+ <td>
+ <p>Subnet ID, should be UUID.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-l3-networks-l3-network--network-id--subnets-subnet--subnet-id--"></span>
+ <div id="operation--network-l3-networks-l3-network--network-id--subnets-subnet--subnet-id--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing subnet</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing subnet</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ network-id
+ </td>
+ <td>
+ <p>Network ID, should be uuid. Unique across A&AI.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ subnet-id
+ </td>
+ <td>
+ <p>Subnet ID, should be UUID.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-l3-networks-l3-network--network-id--subnets-subnet--subnet-id--host-routes-"></span>
+ <div id="operation--network-l3-networks-l3-network--network-id--subnets-subnet--subnet-id--host-routes-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns host-routes</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns host-routes</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ network-id
+ </td>
+ <td>
+ <p>Network ID, should be uuid. Unique across A&AI.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ subnet-id
+ </td>
+ <td>
+ <p>Subnet ID, should be UUID.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network, governed by some naming convention..</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-role
+ </td>
+ <td>
+ <p>Role the network plans - who defines these values?</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ contrail-network-fqdn
+ </td>
+ <td>
+ <p>Contrail FQDN for the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-id
+ </td>
+ <td>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-version
+ </td>
+ <td>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ subnet-name
+ </td>
+ <td>
+ <p>Name associated with the subnet.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/host-routes">/host-routes</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-l3-networks-l3-network--network-id--subnets-subnet--subnet-id--host-routes-host-route--host-route-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns host-route</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns host-route</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ network-id
+ </td>
+ <td>
+ <p>Network ID, should be uuid. Unique across A&AI.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ subnet-id
+ </td>
+ <td>
+ <p>Subnet ID, should be UUID.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ host-route-id
+ </td>
+ <td>
+ <p>host-route id</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network, governed by some naming convention..</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-role
+ </td>
+ <td>
+ <p>Role the network plans - who defines these values?</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ contrail-network-fqdn
+ </td>
+ <td>
+ <p>Contrail FQDN for the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-id
+ </td>
+ <td>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-version
+ </td>
+ <td>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ subnet-name
+ </td>
+ <td>
+ <p>Name associated with the subnet.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/host-route">/host-route</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-l3-networks-l3-network--network-id--subnets-subnet--subnet-id--host-routes-host-route--host-route-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing host-route</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing host-route</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>host-route object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/host-route">/host-route</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ network-id
+ </td>
+ <td>
+ <p>Network ID, should be uuid. Unique across A&AI.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ subnet-id
+ </td>
+ <td>
+ <p>Subnet ID, should be UUID.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ host-route-id
+ </td>
+ <td>
+ <p>host-route id</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-l3-networks-l3-network--network-id--subnets-subnet--subnet-id--host-routes-host-route--host-route-id--"></span>
+ <div id="operation--network-l3-networks-l3-network--network-id--subnets-subnet--subnet-id--host-routes-host-route--host-route-id--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing host-route</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing host-route</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>host-route object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/host-route">/host-route</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ network-id
+ </td>
+ <td>
+ <p>Network ID, should be uuid. Unique across A&AI.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ subnet-id
+ </td>
+ <td>
+ <p>Subnet ID, should be UUID.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ host-route-id
+ </td>
+ <td>
+ <p>host-route id</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-l3-networks-l3-network--network-id--subnets-subnet--subnet-id--host-routes-host-route--host-route-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing host-route</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing host-route</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ network-id
+ </td>
+ <td>
+ <p>Network ID, should be uuid. Unique across A&AI.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ subnet-id
+ </td>
+ <td>
+ <p>Subnet ID, should be UUID.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ host-route-id
+ </td>
+ <td>
+ <p>host-route id</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-l3-networks-l3-network--network-id--subnets-subnet--subnet-id--host-routes-host-route--host-route-id--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ network-id
+ </td>
+ <td>
+ <p>Network ID, should be uuid. Unique across A&AI.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ subnet-id
+ </td>
+ <td>
+ <p>Subnet ID, should be UUID.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ host-route-id
+ </td>
+ <td>
+ <p>host-route id</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-l3-networks-l3-network--network-id--subnets-subnet--subnet-id--host-routes-host-route--host-route-id--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ network-id
+ </td>
+ <td>
+ <p>Network ID, should be uuid. Unique across A&AI.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ subnet-id
+ </td>
+ <td>
+ <p>Subnet ID, should be UUID.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ host-route-id
+ </td>
+ <td>
+ <p>host-route id</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-l3-networks-l3-network--network-id--subnets-subnet--subnet-id--relationship-list-relationship-"></span>
+ <div id="operation--network-l3-networks-l3-network--network-id--subnets-subnet--subnet-id--relationship-list-relationship-put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkSubnetsSubnet.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ network-id
+ </td>
+ <td>
+ <p>Network ID, should be uuid. Unique across A&AI.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ subnet-id
+ </td>
+ <td>
+ <p>Subnet ID, should be UUID.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-l3-networks-l3-network--network-id--subnets-subnet--subnet-id--relationship-list-relationship-"></span>
+ <div id="operation--network-l3-networks-l3-network--network-id--subnets-subnet--subnet-id--relationship-list-relationship-delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ network-id
+ </td>
+ <td>
+ <p>Network ID, should be uuid. Unique across A&AI.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ subnet-id
+ </td>
+ <td>
+ <p>Subnet ID, should be UUID.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-lag-links-"></span>
+ <div id="operation--network-lag-links-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns lag-links</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/lag-links</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns lag-links</p>
+
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/lag-links">/lag-links</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-lag-links-lag-link--link-name--"></span>
+ <div id="operation--network-lag-links-lag-link--link-name--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns lag-link</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/lag-links/lag-link/{link-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns lag-link</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ link-name
+ </td>
+ <td>
+ <p>Alphabetical concatenation of lag-interface names</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/lag-link">/lag-link</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-lag-links-lag-link--link-name--"></span>
+ <div id="operation--network-lag-links-lag-link--link-name--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing lag-link</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/lag-links/lag-link/{link-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing lag-link</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>lag-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkLagLinksLagLink.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/lag-link">/lag-link</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ link-name
+ </td>
+ <td>
+ <p>Alphabetical concatenation of lag-interface names</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-lag-links-lag-link--link-name--"></span>
+ <div id="operation--network-lag-links-lag-link--link-name--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing lag-link</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/lag-links/lag-link/{link-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing lag-link</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>lag-link object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/lag-link">/lag-link</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ link-name
+ </td>
+ <td>
+ <p>Alphabetical concatenation of lag-interface names</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-lag-links-lag-link--link-name--"></span>
+ <div id="operation--network-lag-links-lag-link--link-name--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing lag-link</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/lag-links/lag-link/{link-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing lag-link</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ link-name
+ </td>
+ <td>
+ <p>Alphabetical concatenation of lag-interface names</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-lag-links-lag-link--link-name--relationship-list-relationship-"></span>
+ <div id="operation--network-lag-links-lag-link--link-name--relationship-list-relationship-put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/lag-links/lag-link/{link-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkLagLinksLagLink.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ link-name
+ </td>
+ <td>
+ <p>Alphabetical concatenation of lag-interface names</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-lag-links-lag-link--link-name--relationship-list-relationship-"></span>
+ <div id="operation--network-lag-links-lag-link--link-name--relationship-list-relationship-delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/lag-links/lag-link/{link-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ link-name
+ </td>
+ <td>
+ <p>Alphabetical concatenation of lag-interface names</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-logical-links-"></span>
+ <div id="operation--network-logical-links-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns logical-links</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/logical-links</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns logical-links</p>
+
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/logical-links">/logical-links</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-logical-links-logical-link--link-name--"></span>
+ <div id="operation--network-logical-links-logical-link--link-name--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns logical-link</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/logical-links/logical-link/{link-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns logical-link</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ link-name
+ </td>
+ <td>
+ <p>e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-id
+ </td>
+ <td>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ widget-model-version
+ </td>
+ <td>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this VNF by BAU Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ link-id
+ </td>
+ <td>
+ <p>UUID of the logical-link, SDNC generates this.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ circuit-id
+ </td>
+ <td>
+ <p>Circuit id</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ purpose
+ </td>
+ <td>
+ <p>Reason for this entity, role it is playing</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/logical-link">/logical-link</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-logical-links-logical-link--link-name--"></span>
+ <div id="operation--network-logical-links-logical-link--link-name--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing logical-link</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/logical-links/logical-link/{link-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing logical-link</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>logical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkLogicalLinksLogicalLink.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/logical-link">/logical-link</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ link-name
+ </td>
+ <td>
+ <p>e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-logical-links-logical-link--link-name--"></span>
+ <div id="operation--network-logical-links-logical-link--link-name--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing logical-link</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/logical-links/logical-link/{link-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing logical-link</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>logical-link object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/logical-link">/logical-link</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ link-name
+ </td>
+ <td>
+ <p>e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-logical-links-logical-link--link-name--"></span>
+ <div id="operation--network-logical-links-logical-link--link-name--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing logical-link</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/logical-links/logical-link/{link-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing logical-link</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ link-name
+ </td>
+ <td>
+ <p>e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-logical-links-logical-link--link-name--relationship-list-relationship-"></span>
+ <div id="operation--network-logical-links-logical-link--link-name--relationship-list-relationship-put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/logical-links/logical-link/{link-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkLogicalLinksLogicalLink.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ link-name
+ </td>
+ <td>
+ <p>e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-logical-links-logical-link--link-name--relationship-list-relationship-"></span>
+ <div id="operation--network-logical-links-logical-link--link-name--relationship-list-relationship-delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/logical-links/logical-link/{link-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ link-name
+ </td>
+ <td>
+ <p>e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-multicast-configurations-"></span>
+ <div id="operation--network-multicast-configurations-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns multicast-configurations</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/multicast-configurations</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns multicast-configurations</p>
+
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/multicast-configurations">/multicast-configurations</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-multicast-configurations-multicast-configuration--multicast-configuration-id--"></span>
+ <div id="operation--network-multicast-configurations-multicast-configuration--multicast-configuration-id--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns multicast-configuration</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/multicast-configurations/multicast-configuration/{multicast-configuration-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns multicast-configuration</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ multicast-configuration-id
+ </td>
+ <td>
+ <p>Unique id of multicast configuration.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/multicast-configuration">/multicast-configuration</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-multicast-configurations-multicast-configuration--multicast-configuration-id--"></span>
+ <div id="operation--network-multicast-configurations-multicast-configuration--multicast-configuration-id--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing multicast-configuration</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/multicast-configurations/multicast-configuration/{multicast-configuration-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing multicast-configuration</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>multicast-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkMulticastConfigurationsMulticastConfiguration.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/multicast-configuration">/multicast-configuration</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ multicast-configuration-id
+ </td>
+ <td>
+ <p>Unique id of multicast configuration.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-multicast-configurations-multicast-configuration--multicast-configuration-id--"></span>
+ <div id="operation--network-multicast-configurations-multicast-configuration--multicast-configuration-id--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing multicast-configuration</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/multicast-configurations/multicast-configuration/{multicast-configuration-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing multicast-configuration</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>multicast-configuration object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/multicast-configuration">/multicast-configuration</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ multicast-configuration-id
+ </td>
+ <td>
+ <p>Unique id of multicast configuration.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-multicast-configurations-multicast-configuration--multicast-configuration-id--"></span>
+ <div id="operation--network-multicast-configurations-multicast-configuration--multicast-configuration-id--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing multicast-configuration</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/multicast-configurations/multicast-configuration/{multicast-configuration-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing multicast-configuration</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ multicast-configuration-id
+ </td>
+ <td>
+ <p>Unique id of multicast configuration.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-multicast-configurations-multicast-configuration--multicast-configuration-id--relationship-list-relationship-"></span>
+ <div id="operation--network-multicast-configurations-multicast-configuration--multicast-configuration-id--relationship-list-relationship-put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkMulticastConfigurationsMulticastConfiguration.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ multicast-configuration-id
+ </td>
+ <td>
+ <p>Unique id of multicast configuration.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-multicast-configurations-multicast-configuration--multicast-configuration-id--relationship-list-relationship-"></span>
+ <div id="operation--network-multicast-configurations-multicast-configuration--multicast-configuration-id--relationship-list-relationship-delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ multicast-configuration-id
+ </td>
+ <td>
+ <p>Unique id of multicast configuration.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-network-policies-"></span>
+ <div id="operation--network-network-policies-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns network-policies</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/network-policies</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns network-policies</p>
+
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/network-policies">/network-policies</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-network-policies-network-policy--network-policy-id--"></span>
+ <div id="operation--network-network-policies-network-policy--network-policy-id--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns network-policy</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/network-policies/network-policy/{network-policy-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns network-policy</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ network-policy-id
+ </td>
+ <td>
+ <p>UUID representing unique key to this instance</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-policy-fqdn
+ </td>
+ <td>
+ <p>Contrail FQDN for the policy</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/network-policy">/network-policy</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-network-policies-network-policy--network-policy-id--"></span>
+ <div id="operation--network-network-policies-network-policy--network-policy-id--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing network-policy</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/network-policies/network-policy/{network-policy-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing network-policy</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>network-policy object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNetworkPoliciesNetworkPolicy.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/network-policy">/network-policy</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ network-policy-id
+ </td>
+ <td>
+ <p>UUID representing unique key to this instance</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-network-policies-network-policy--network-policy-id--"></span>
+ <div id="operation--network-network-policies-network-policy--network-policy-id--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing network-policy</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/network-policies/network-policy/{network-policy-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing network-policy</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>network-policy object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/network-policy">/network-policy</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ network-policy-id
+ </td>
+ <td>
+ <p>UUID representing unique key to this instance</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-network-policies-network-policy--network-policy-id--"></span>
+ <div id="operation--network-network-policies-network-policy--network-policy-id--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing network-policy</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/network-policies/network-policy/{network-policy-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing network-policy</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ network-policy-id
+ </td>
+ <td>
+ <p>UUID representing unique key to this instance</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-network-policies-network-policy--network-policy-id--relationship-list-relationship-"></span>
+ <div id="operation--network-network-policies-network-policy--network-policy-id--relationship-list-relationship-put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNetworkPoliciesNetworkPolicy.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ network-policy-id
+ </td>
+ <td>
+ <p>UUID representing unique key to this instance</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-network-policies-network-policy--network-policy-id--relationship-list-relationship-"></span>
+ <div id="operation--network-network-policies-network-policy--network-policy-id--relationship-list-relationship-delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ network-policy-id
+ </td>
+ <td>
+ <p>UUID representing unique key to this instance</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-newvces-"></span>
+ <div id="operation--network-newvces-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns newvces</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/newvces</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns newvces</p>
+
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/newvces">/newvces</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-newvces-newvce--vnf-id2--"></span>
+ <div id="operation--network-newvces-newvce--vnf-id2--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns newvce</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/newvces/newvce/{vnf-id2}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns newvce</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id2
+ </td>
+ <td>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name
+ </td>
+ <td>
+ <p>Name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name2
+ </td>
+ <td>
+ <p>Alternate name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this VNF by BAU Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/newvce">/newvce</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-newvces-newvce--vnf-id2--"></span>
+ <div id="operation--network-newvces-newvce--vnf-id2--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing newvce</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/newvces/newvce/{vnf-id2}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing newvce</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>newvce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvce.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/newvce">/newvce</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id2
+ </td>
+ <td>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-newvces-newvce--vnf-id2--"></span>
+ <div id="operation--network-newvces-newvce--vnf-id2--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing newvce</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/newvces/newvce/{vnf-id2}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing newvce</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>newvce object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/newvce">/newvce</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id2
+ </td>
+ <td>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-newvces-newvce--vnf-id2--"></span>
+ <div id="operation--network-newvces-newvce--vnf-id2--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing newvce</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/newvces/newvce/{vnf-id2}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing newvce</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id2
+ </td>
+ <td>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-newvces-newvce--vnf-id2--l-interfaces-"></span>
+ <div id="operation--network-newvces-newvce--vnf-id2--l-interfaces-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l-interfaces</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/newvces/newvce/{vnf-id2}/l-interfaces</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l-interfaces</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id2
+ </td>
+ <td>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name
+ </td>
+ <td>
+ <p>Name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name2
+ </td>
+ <td>
+ <p>Alternate name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this VNF by BAU Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l-interfaces">/l-interfaces</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--"></span>
+ <div id="operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l-interface</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l-interface</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id2
+ </td>
+ <td>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name
+ </td>
+ <td>
+ <p>Name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name2
+ </td>
+ <td>
+ <p>Alternate name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this VNF by BAU Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l-interface">/l-interface</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--"></span>
+ <div id="operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l-interface</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l-interface</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterface.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l-interface">/l-interface</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id2
+ </td>
+ <td>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--"></span>
+ <div id="operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l-interface</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l-interface</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l-interface object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l-interface">/l-interface</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id2
+ </td>
+ <td>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--"></span>
+ <div id="operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l-interface</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l-interface</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id2
+ </td>
+ <td>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--l3-interface-ipv4-address-list--l3-interface-ipv4-address--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id2
+ </td>
+ <td>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name
+ </td>
+ <td>
+ <p>Name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name2
+ </td>
+ <td>
+ <p>Alternate name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this VNF by BAU Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-subnet-id
+ </td>
+ <td>
+ <p>Neutron id of subnet that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--l3-interface-ipv4-address-list--l3-interface-ipv4-address--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id2
+ </td>
+ <td>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--l3-interface-ipv4-address-list--l3-interface-ipv4-address--"></span>
+ <div id="operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--l3-interface-ipv4-address-list--l3-interface-ipv4-address--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv4-address-list object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id2
+ </td>
+ <td>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--l3-interface-ipv4-address-list--l3-interface-ipv4-address--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id2
+ </td>
+ <td>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--l3-interface-ipv4-address-list--l3-interface-ipv4-address--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id2
+ </td>
+ <td>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--l3-interface-ipv4-address-list--l3-interface-ipv4-address--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id2
+ </td>
+ <td>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--l3-interface-ipv6-address-list--l3-interface-ipv6-address--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id2
+ </td>
+ <td>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name
+ </td>
+ <td>
+ <p>Name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name2
+ </td>
+ <td>
+ <p>Alternate name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this VNF by BAU Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-subnet-id
+ </td>
+ <td>
+ <p>Neutron id of subnet that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--l3-interface-ipv6-address-list--l3-interface-ipv6-address--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id2
+ </td>
+ <td>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--l3-interface-ipv6-address-list--l3-interface-ipv6-address--"></span>
+ <div id="operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--l3-interface-ipv6-address-list--l3-interface-ipv6-address--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv6-address-list object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id2
+ </td>
+ <td>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--l3-interface-ipv6-address-list--l3-interface-ipv6-address--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id2
+ </td>
+ <td>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--l3-interface-ipv6-address-list--l3-interface-ipv6-address--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id2
+ </td>
+ <td>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--l3-interface-ipv6-address-list--l3-interface-ipv6-address--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id2
+ </td>
+ <td>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--relationship-list-relationship-"></span>
+ <div id="operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--relationship-list-relationship-put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterface.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id2
+ </td>
+ <td>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--relationship-list-relationship-"></span>
+ <div id="operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--relationship-list-relationship-delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id2
+ </td>
+ <td>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--sriov-vfs-"></span>
+ <div id="operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--sriov-vfs-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns sriov-vfs</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns sriov-vfs</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id2
+ </td>
+ <td>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name
+ </td>
+ <td>
+ <p>Name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name2
+ </td>
+ <td>
+ <p>Alternate name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this VNF by BAU Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/sriov-vfs">/sriov-vfs</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns sriov-vf</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns sriov-vf</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id2
+ </td>
+ <td>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name
+ </td>
+ <td>
+ <p>Name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name2
+ </td>
+ <td>
+ <p>Alternate name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this VNF by BAU Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vf-vlan-filter
+ </td>
+ <td>
+ <p>This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vf-mac-filter
+ </td>
+ <td>
+ <p>When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vf-vlan-strip
+ </td>
+ <td>
+ <p>When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/sriov-vf">/sriov-vf</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing sriov-vf</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing sriov-vf</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/sriov-vf">/sriov-vf</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id2
+ </td>
+ <td>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--"></span>
+ <div id="operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing sriov-vf</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing sriov-vf</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>sriov-vf object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/sriov-vf">/sriov-vf</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id2
+ </td>
+ <td>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing sriov-vf</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing sriov-vf</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id2
+ </td>
+ <td>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id2
+ </td>
+ <td>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id2
+ </td>
+ <td>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--vlans-"></span>
+ <div id="operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--vlans-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns vlans</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns vlans</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id2
+ </td>
+ <td>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name
+ </td>
+ <td>
+ <p>Name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name2
+ </td>
+ <td>
+ <p>Alternate name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this VNF by BAU Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/vlans">/vlans</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns vlan</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns vlan</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id2
+ </td>
+ <td>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name
+ </td>
+ <td>
+ <p>Name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name2
+ </td>
+ <td>
+ <p>Alternate name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this VNF by BAU Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vpn-key
+ </td>
+ <td>
+ <p>This indicates the customers VPN ID associated with this vlan</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/vlan">/vlan</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing vlan</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing vlan</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/vlan">/vlan</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id2
+ </td>
+ <td>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--"></span>
+ <div id="operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing vlan</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing vlan</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>vlan object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/vlan">/vlan</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id2
+ </td>
+ <td>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing vlan</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing vlan</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id2
+ </td>
+ <td>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--l3-interface-ipv4-address-list--l3-interface-ipv4-address--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id2
+ </td>
+ <td>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name
+ </td>
+ <td>
+ <p>Name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name2
+ </td>
+ <td>
+ <p>Alternate name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this VNF by BAU Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vpn-key
+ </td>
+ <td>
+ <p>This indicates the customers VPN ID associated with this vlan</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-subnet-id
+ </td>
+ <td>
+ <p>Neutron id of subnet that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--l3-interface-ipv4-address-list--l3-interface-ipv4-address--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id2
+ </td>
+ <td>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--l3-interface-ipv4-address-list--l3-interface-ipv4-address--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv4-address-list object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id2
+ </td>
+ <td>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--l3-interface-ipv4-address-list--l3-interface-ipv4-address--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id2
+ </td>
+ <td>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id2
+ </td>
+ <td>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id2
+ </td>
+ <td>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--l3-interface-ipv6-address-list--l3-interface-ipv6-address--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id2
+ </td>
+ <td>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name
+ </td>
+ <td>
+ <p>Name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name2
+ </td>
+ <td>
+ <p>Alternate name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this VNF by BAU Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vpn-key
+ </td>
+ <td>
+ <p>This indicates the customers VPN ID associated with this vlan</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-subnet-id
+ </td>
+ <td>
+ <p>Neutron id of subnet that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--l3-interface-ipv6-address-list--l3-interface-ipv6-address--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id2
+ </td>
+ <td>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--l3-interface-ipv6-address-list--l3-interface-ipv6-address--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv6-address-list object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id2
+ </td>
+ <td>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--l3-interface-ipv6-address-list--l3-interface-ipv6-address--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id2
+ </td>
+ <td>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id2
+ </td>
+ <td>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id2
+ </td>
+ <td>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id2
+ </td>
+ <td>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id2
+ </td>
+ <td>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-newvces-newvce--vnf-id2--relationship-list-relationship-"></span>
+ <div id="operation--network-newvces-newvce--vnf-id2--relationship-list-relationship-put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/newvces/newvce/{vnf-id2}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvce.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id2
+ </td>
+ <td>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-newvces-newvce--vnf-id2--relationship-list-relationship-"></span>
+ <div id="operation--network-newvces-newvce--vnf-id2--relationship-list-relationship-delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/newvces/newvce/{vnf-id2}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id2
+ </td>
+ <td>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-physical-links-"></span>
+ <div id="operation--network-physical-links-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns physical-links</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/physical-links</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns physical-links</p>
+
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/physical-links">/physical-links</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-physical-links-physical-link--link-name--"></span>
+ <div id="operation--network-physical-links-physical-link--link-name--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns physical-link</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/physical-links/physical-link/{link-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns physical-link</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ link-name
+ </td>
+ <td>
+ <p>e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ circuit-id
+ </td>
+ <td>
+ <p>Circuit it</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/physical-link">/physical-link</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-physical-links-physical-link--link-name--"></span>
+ <div id="operation--network-physical-links-physical-link--link-name--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing physical-link</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/physical-links/physical-link/{link-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing physical-link</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>physical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPhysicalLinksPhysicalLink.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/physical-link">/physical-link</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ link-name
+ </td>
+ <td>
+ <p>e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-physical-links-physical-link--link-name--"></span>
+ <div id="operation--network-physical-links-physical-link--link-name--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing physical-link</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/physical-links/physical-link/{link-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing physical-link</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>physical-link object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/physical-link">/physical-link</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ link-name
+ </td>
+ <td>
+ <p>e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-physical-links-physical-link--link-name--"></span>
+ <div id="operation--network-physical-links-physical-link--link-name--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing physical-link</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/physical-links/physical-link/{link-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing physical-link</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ link-name
+ </td>
+ <td>
+ <p>e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-physical-links-physical-link--link-name--relationship-list-relationship-"></span>
+ <div id="operation--network-physical-links-physical-link--link-name--relationship-list-relationship-put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/physical-links/physical-link/{link-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPhysicalLinksPhysicalLink.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ link-name
+ </td>
+ <td>
+ <p>e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-physical-links-physical-link--link-name--relationship-list-relationship-"></span>
+ <div id="operation--network-physical-links-physical-link--link-name--relationship-list-relationship-delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/physical-links/physical-link/{link-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ link-name
+ </td>
+ <td>
+ <p>e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-"></span>
+ <div id="operation--network-pnfs-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns pnfs</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/pnfs</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns pnfs</p>
+
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/pnfs">/pnfs</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--"></span>
+ <div id="operation--network-pnfs-pnf--pnf-name--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns pnf</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/pnfs/pnf/{pnf-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns pnf</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/pnf">/pnf</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--"></span>
+ <div id="operation--network-pnfs-pnf--pnf-name--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing pnf</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/pnfs/pnf/{pnf-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing pnf</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>pnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnf.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/pnf">/pnf</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--"></span>
+ <div id="operation--network-pnfs-pnf--pnf-name--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing pnf</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/pnfs/pnf/{pnf-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing pnf</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>pnf object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/pnf">/pnf</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--"></span>
+ <div id="operation--network-pnfs-pnf--pnf-name--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing pnf</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/pnfs/pnf/{pnf-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing pnf</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--lag-interfaces-"></span>
+ <div id="operation--network-pnfs-pnf--pnf-name--lag-interfaces-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns lag-interfaces</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/pnfs/pnf/{pnf-name}/lag-interfaces</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns lag-interfaces</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/lag-interfaces">/lag-interfaces</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--"></span>
+ <div id="operation--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns lag-interface</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns lag-interface</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-role
+ </td>
+ <td>
+ <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/lag-interface">/lag-interface</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--"></span>
+ <div id="operation--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing lag-interface</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing lag-interface</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterface.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/lag-interface">/lag-interface</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--"></span>
+ <div id="operation--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing lag-interface</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing lag-interface</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>lag-interface object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/lag-interface">/lag-interface</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--"></span>
+ <div id="operation--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing lag-interface</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing lag-interface</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-"></span>
+ <div id="operation--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l-interfaces</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l-interfaces</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-role
+ </td>
+ <td>
+ <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l-interfaces">/l-interfaces</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l-interface</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l-interface</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-role
+ </td>
+ <td>
+ <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l-interface">/l-interface</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l-interface</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l-interface</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l-interface">/l-interface</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--"></span>
+ <div id="operation--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l-interface</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l-interface</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l-interface object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l-interface">/l-interface</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l-interface</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l-interface</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-role
+ </td>
+ <td>
+ <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-subnet-id
+ </td>
+ <td>
+ <p>Neutron id of subnet that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv4-address-list object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-role
+ </td>
+ <td>
+ <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-subnet-id
+ </td>
+ <td>
+ <p>Neutron id of subnet that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv6-address-list object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns sriov-vfs</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns sriov-vfs</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-role
+ </td>
+ <td>
+ <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/sriov-vfs">/sriov-vfs</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns sriov-vf</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns sriov-vf</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-role
+ </td>
+ <td>
+ <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vf-vlan-filter
+ </td>
+ <td>
+ <p>This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vf-mac-filter
+ </td>
+ <td>
+ <p>When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vf-vlan-strip
+ </td>
+ <td>
+ <p>When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/sriov-vf">/sriov-vf</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing sriov-vf</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing sriov-vf</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/sriov-vf">/sriov-vf</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing sriov-vf</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing sriov-vf</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>sriov-vf object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/sriov-vf">/sriov-vf</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing sriov-vf</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing sriov-vf</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns vlans</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns vlans</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-role
+ </td>
+ <td>
+ <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/vlans">/vlans</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns vlan</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns vlan</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-role
+ </td>
+ <td>
+ <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vpn-key
+ </td>
+ <td>
+ <p>This indicates the customers VPN ID associated with this vlan</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/vlan">/vlan</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing vlan</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing vlan</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/vlan">/vlan</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--"></span>
+ <div id="operation--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing vlan</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing vlan</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>vlan object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/vlan">/vlan</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing vlan</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing vlan</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-role
+ </td>
+ <td>
+ <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vpn-key
+ </td>
+ <td>
+ <p>This indicates the customers VPN ID associated with this vlan</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-subnet-id
+ </td>
+ <td>
+ <p>Neutron id of subnet that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv4-address-list object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-role
+ </td>
+ <td>
+ <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vpn-key
+ </td>
+ <td>
+ <p>This indicates the customers VPN ID associated with this vlan</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-subnet-id
+ </td>
+ <td>
+ <p>Neutron id of subnet that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv6-address-list object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--relationship-list-relationship-"></span>
+ <div id="operation--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--relationship-list-relationship-put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterface.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--relationship-list-relationship-"></span>
+ <div id="operation--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--relationship-list-relationship-delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--p-interfaces-"></span>
+ <div id="operation--network-pnfs-pnf--pnf-name--p-interfaces-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns p-interfaces</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/pnfs/pnf/{pnf-name}/p-interfaces</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns p-interfaces</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/p-interfaces">/p-interfaces</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--"></span>
+ <div id="operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns p-interface</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns p-interface</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/p-interface">/p-interface</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--"></span>
+ <div id="operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing p-interface</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing p-interface</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterface.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/p-interface">/p-interface</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--"></span>
+ <div id="operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing p-interface</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing p-interface</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>p-interface object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/p-interface">/p-interface</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--"></span>
+ <div id="operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing p-interface</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing p-interface</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-"></span>
+ <div id="operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l-interfaces</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l-interfaces</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l-interfaces">/l-interfaces</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l-interface</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l-interface</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l-interface">/l-interface</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l-interface</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l-interface</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l-interface">/l-interface</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--"></span>
+ <div id="operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l-interface</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l-interface</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l-interface object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l-interface">/l-interface</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l-interface</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l-interface</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-subnet-id
+ </td>
+ <td>
+ <p>Neutron id of subnet that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv4-address-list object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-subnet-id
+ </td>
+ <td>
+ <p>Neutron id of subnet that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv6-address-list object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns sriov-vfs</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns sriov-vfs</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/sriov-vfs">/sriov-vfs</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns sriov-vf</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns sriov-vf</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vf-vlan-filter
+ </td>
+ <td>
+ <p>This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vf-mac-filter
+ </td>
+ <td>
+ <p>When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vf-vlan-strip
+ </td>
+ <td>
+ <p>When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/sriov-vf">/sriov-vf</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing sriov-vf</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing sriov-vf</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/sriov-vf">/sriov-vf</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing sriov-vf</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing sriov-vf</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>sriov-vf object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/sriov-vf">/sriov-vf</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing sriov-vf</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing sriov-vf</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns vlans</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns vlans</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/vlans">/vlans</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns vlan</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns vlan</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vpn-key
+ </td>
+ <td>
+ <p>This indicates the customers VPN ID associated with this vlan</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/vlan">/vlan</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing vlan</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing vlan</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/vlan">/vlan</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--"></span>
+ <div id="operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing vlan</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing vlan</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>vlan object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/vlan">/vlan</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing vlan</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing vlan</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vpn-key
+ </td>
+ <td>
+ <p>This indicates the customers VPN ID associated with this vlan</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-subnet-id
+ </td>
+ <td>
+ <p>Neutron id of subnet that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv4-address-list object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vpn-key
+ </td>
+ <td>
+ <p>This indicates the customers VPN ID associated with this vlan</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-subnet-id
+ </td>
+ <td>
+ <p>Neutron id of subnet that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv6-address-list object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--relationship-list-relationship-"></span>
+ <div id="operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--relationship-list-relationship-put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterface.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--relationship-list-relationship-"></span>
+ <div id="operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--relationship-list-relationship-delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--sriov-pfs-"></span>
+ <div id="operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--sriov-pfs-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns sriov-pfs</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns sriov-pfs</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/sriov-pfs">/sriov-pfs</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns sriov-pf</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns sriov-pf</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pf-pci-id
+ </td>
+ <td>
+ <p>Identifier for the sriov-pf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ inv-status
+ </td>
+ <td>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/sriov-pf">/sriov-pf</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing sriov-pf</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing sriov-pf</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/sriov-pf">/sriov-pf</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pf-pci-id
+ </td>
+ <td>
+ <p>Identifier for the sriov-pf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--"></span>
+ <div id="operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing sriov-pf</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing sriov-pf</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>sriov-pf object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/sriov-pf">/sriov-pf</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pf-pci-id
+ </td>
+ <td>
+ <p>Identifier for the sriov-pf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing sriov-pf</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing sriov-pf</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pf-pci-id
+ </td>
+ <td>
+ <p>Identifier for the sriov-pf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pf-pci-id
+ </td>
+ <td>
+ <p>Identifier for the sriov-pf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pf-pci-id
+ </td>
+ <td>
+ <p>Identifier for the sriov-pf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--relationship-list-relationship-"></span>
+ <div id="operation--network-pnfs-pnf--pnf-name--relationship-list-relationship-put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/pnfs/pnf/{pnf-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnf.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-pnfs-pnf--pnf-name--relationship-list-relationship-"></span>
+ <div id="operation--network-pnfs-pnf--pnf-name--relationship-list-relationship-delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/pnfs/pnf/{pnf-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ pnf-name
+ </td>
+ <td>
+ <p>unique name of Physical Network Function.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-route-table-references-"></span>
+ <div id="operation--network-route-table-references-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns route-table-references</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/route-table-references</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns route-table-references</p>
+
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/route-table-references">/route-table-references</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-route-table-references-route-table-reference--route-table-reference-id--"></span>
+ <div id="operation--network-route-table-references-route-table-reference--route-table-reference-id--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns route-table-reference</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/route-table-references/route-table-reference/{route-table-reference-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns route-table-reference</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ route-table-reference-id
+ </td>
+ <td>
+ <p>Route Table Reference id, UUID assigned to this instance.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ route-table-reference-fqdn
+ </td>
+ <td>
+ <p>FQDN entry in the route table.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/route-table-reference">/route-table-reference</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-route-table-references-route-table-reference--route-table-reference-id--"></span>
+ <div id="operation--network-route-table-references-route-table-reference--route-table-reference-id--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing route-table-reference</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/route-table-references/route-table-reference/{route-table-reference-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing route-table-reference</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>route-table-reference object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkRouteTableReferencesRouteTableReference.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/route-table-reference">/route-table-reference</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ route-table-reference-id
+ </td>
+ <td>
+ <p>Route Table Reference id, UUID assigned to this instance.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-route-table-references-route-table-reference--route-table-reference-id--"></span>
+ <div id="operation--network-route-table-references-route-table-reference--route-table-reference-id--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing route-table-reference</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/route-table-references/route-table-reference/{route-table-reference-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing route-table-reference</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>route-table-reference object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/route-table-reference">/route-table-reference</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ route-table-reference-id
+ </td>
+ <td>
+ <p>Route Table Reference id, UUID assigned to this instance.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-route-table-references-route-table-reference--route-table-reference-id--"></span>
+ <div id="operation--network-route-table-references-route-table-reference--route-table-reference-id--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing route-table-reference</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/route-table-references/route-table-reference/{route-table-reference-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing route-table-reference</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ route-table-reference-id
+ </td>
+ <td>
+ <p>Route Table Reference id, UUID assigned to this instance.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-route-table-references-route-table-reference--route-table-reference-id--relationship-list-relationship-"></span>
+ <div id="operation--network-route-table-references-route-table-reference--route-table-reference-id--relationship-list-relationship-put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkRouteTableReferencesRouteTableReference.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ route-table-reference-id
+ </td>
+ <td>
+ <p>Route Table Reference id, UUID assigned to this instance.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-route-table-references-route-table-reference--route-table-reference-id--relationship-list-relationship-"></span>
+ <div id="operation--network-route-table-references-route-table-reference--route-table-reference-id--relationship-list-relationship-delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ route-table-reference-id
+ </td>
+ <td>
+ <p>Route Table Reference id, UUID assigned to this instance.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-site-pair-sets-"></span>
+ <div id="operation--network-site-pair-sets-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns site-pair-sets</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/site-pair-sets</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns site-pair-sets</p>
+
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/site-pair-sets">/site-pair-sets</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-site-pair-sets-site-pair-set--site-pair-set-id--"></span>
+ <div id="operation--network-site-pair-sets-site-pair-set--site-pair-set-id--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns site-pair-set</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/site-pair-sets/site-pair-set/{site-pair-set-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns site-pair-set</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ site-pair-set-id
+ </td>
+ <td>
+ <p>Unique id of site pair set.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/site-pair-set">/site-pair-set</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-site-pair-sets-site-pair-set--site-pair-set-id--"></span>
+ <div id="operation--network-site-pair-sets-site-pair-set--site-pair-set-id--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing site-pair-set</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/site-pair-sets/site-pair-set/{site-pair-set-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing site-pair-set</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>site-pair-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSet.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/site-pair-set">/site-pair-set</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ site-pair-set-id
+ </td>
+ <td>
+ <p>Unique id of site pair set.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-site-pair-sets-site-pair-set--site-pair-set-id--"></span>
+ <div id="operation--network-site-pair-sets-site-pair-set--site-pair-set-id--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing site-pair-set</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/site-pair-sets/site-pair-set/{site-pair-set-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing site-pair-set</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>site-pair-set object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/site-pair-set">/site-pair-set</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ site-pair-set-id
+ </td>
+ <td>
+ <p>Unique id of site pair set.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-site-pair-sets-site-pair-set--site-pair-set-id--"></span>
+ <div id="operation--network-site-pair-sets-site-pair-set--site-pair-set-id--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing site-pair-set</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/site-pair-sets/site-pair-set/{site-pair-set-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing site-pair-set</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ site-pair-set-id
+ </td>
+ <td>
+ <p>Unique id of site pair set.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-site-pair-sets-site-pair-set--site-pair-set-id--relationship-list-relationship-"></span>
+ <div id="operation--network-site-pair-sets-site-pair-set--site-pair-set-id--relationship-list-relationship-put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSet.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ site-pair-set-id
+ </td>
+ <td>
+ <p>Unique id of site pair set.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-site-pair-sets-site-pair-set--site-pair-set-id--relationship-list-relationship-"></span>
+ <div id="operation--network-site-pair-sets-site-pair-set--site-pair-set-id--relationship-list-relationship-delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ site-pair-set-id
+ </td>
+ <td>
+ <p>Unique id of site pair set.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-site-pair-sets-site-pair-set--site-pair-set-id--routing-instances-"></span>
+ <div id="operation--network-site-pair-sets-site-pair-set--site-pair-set-id--routing-instances-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns routing-instances</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns routing-instances</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ site-pair-set-id
+ </td>
+ <td>
+ <p>Unique id of site pair set.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/routing-instances">/routing-instances</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-site-pair-sets-site-pair-set--site-pair-set-id--routing-instances-routing-instance--routing-instance-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns routing-instance</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns routing-instance</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ site-pair-set-id
+ </td>
+ <td>
+ <p>Unique id of site pair set.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ routing-instance-id
+ </td>
+ <td>
+ <p>Unique id of routing instance</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/routing-instance">/routing-instance</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-site-pair-sets-site-pair-set--site-pair-set-id--routing-instances-routing-instance--routing-instance-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing routing-instance</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing routing-instance</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>routing-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/routing-instance">/routing-instance</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ site-pair-set-id
+ </td>
+ <td>
+ <p>Unique id of site pair set.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ routing-instance-id
+ </td>
+ <td>
+ <p>Unique id of routing instance</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-site-pair-sets-site-pair-set--site-pair-set-id--routing-instances-routing-instance--routing-instance-id--"></span>
+ <div id="operation--network-site-pair-sets-site-pair-set--site-pair-set-id--routing-instances-routing-instance--routing-instance-id--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing routing-instance</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing routing-instance</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>routing-instance object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/routing-instance">/routing-instance</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ site-pair-set-id
+ </td>
+ <td>
+ <p>Unique id of site pair set.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ routing-instance-id
+ </td>
+ <td>
+ <p>Unique id of routing instance</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-site-pair-sets-site-pair-set--site-pair-set-id--routing-instances-routing-instance--routing-instance-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing routing-instance</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing routing-instance</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ site-pair-set-id
+ </td>
+ <td>
+ <p>Unique id of site pair set.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ routing-instance-id
+ </td>
+ <td>
+ <p>Unique id of routing instance</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-site-pair-sets-site-pair-set--site-pair-set-id--routing-instances-routing-instance--routing-instance-id--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ site-pair-set-id
+ </td>
+ <td>
+ <p>Unique id of site pair set.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ routing-instance-id
+ </td>
+ <td>
+ <p>Unique id of routing instance</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-site-pair-sets-site-pair-set--site-pair-set-id--routing-instances-routing-instance--routing-instance-id--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ site-pair-set-id
+ </td>
+ <td>
+ <p>Unique id of site pair set.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ routing-instance-id
+ </td>
+ <td>
+ <p>Unique id of routing instance</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-site-pair-sets-site-pair-set--site-pair-set-id--routing-instances-routing-instance--routing-instance-id--site-pairs-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns site-pairs</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns site-pairs</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ site-pair-set-id
+ </td>
+ <td>
+ <p>Unique id of site pair set.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ routing-instance-id
+ </td>
+ <td>
+ <p>Unique id of routing instance</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/site-pairs">/site-pairs</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns site-pair</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns site-pair</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ site-pair-set-id
+ </td>
+ <td>
+ <p>Unique id of site pair set.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ routing-instance-id
+ </td>
+ <td>
+ <p>Unique id of routing instance</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ site-pair-id
+ </td>
+ <td>
+ <p>unique identifier of probe</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/site-pair">/site-pair</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing site-pair</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing site-pair</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>site-pair object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/site-pair">/site-pair</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ site-pair-set-id
+ </td>
+ <td>
+ <p>Unique id of site pair set.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ routing-instance-id
+ </td>
+ <td>
+ <p>Unique id of routing instance</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ site-pair-id
+ </td>
+ <td>
+ <p>unique identifier of probe</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing site-pair</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing site-pair</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>site-pair object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/site-pair">/site-pair</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ site-pair-set-id
+ </td>
+ <td>
+ <p>Unique id of site pair set.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ routing-instance-id
+ </td>
+ <td>
+ <p>Unique id of routing instance</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ site-pair-id
+ </td>
+ <td>
+ <p>unique identifier of probe</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing site-pair</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing site-pair</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ site-pair-set-id
+ </td>
+ <td>
+ <p>Unique id of site pair set.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ routing-instance-id
+ </td>
+ <td>
+ <p>Unique id of routing instance</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ site-pair-id
+ </td>
+ <td>
+ <p>unique identifier of probe</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns classes-of-service</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns classes-of-service</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ site-pair-set-id
+ </td>
+ <td>
+ <p>Unique id of site pair set.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ routing-instance-id
+ </td>
+ <td>
+ <p>Unique id of routing instance</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ site-pair-id
+ </td>
+ <td>
+ <p>unique identifier of probe</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/classes-of-service">/classes-of-service</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns class-of-service</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns class-of-service</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ site-pair-set-id
+ </td>
+ <td>
+ <p>Unique id of site pair set.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ routing-instance-id
+ </td>
+ <td>
+ <p>Unique id of routing instance</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ site-pair-id
+ </td>
+ <td>
+ <p>unique identifier of probe</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cos
+ </td>
+ <td>
+ <p>unique identifier of probe</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/class-of-service">/class-of-service</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing class-of-service</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing class-of-service</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>class-of-service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/class-of-service">/class-of-service</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ site-pair-set-id
+ </td>
+ <td>
+ <p>Unique id of site pair set.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ routing-instance-id
+ </td>
+ <td>
+ <p>Unique id of routing instance</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ site-pair-id
+ </td>
+ <td>
+ <p>unique identifier of probe</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cos
+ </td>
+ <td>
+ <p>unique identifier of probe</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing class-of-service</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing class-of-service</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>class-of-service object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/class-of-service">/class-of-service</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ site-pair-set-id
+ </td>
+ <td>
+ <p>Unique id of site pair set.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ routing-instance-id
+ </td>
+ <td>
+ <p>Unique id of routing instance</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ site-pair-id
+ </td>
+ <td>
+ <p>unique identifier of probe</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cos
+ </td>
+ <td>
+ <p>unique identifier of probe</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing class-of-service</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing class-of-service</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ site-pair-set-id
+ </td>
+ <td>
+ <p>Unique id of site pair set.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ routing-instance-id
+ </td>
+ <td>
+ <p>Unique id of routing instance</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ site-pair-id
+ </td>
+ <td>
+ <p>unique identifier of probe</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cos
+ </td>
+ <td>
+ <p>unique identifier of probe</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ site-pair-set-id
+ </td>
+ <td>
+ <p>Unique id of site pair set.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ routing-instance-id
+ </td>
+ <td>
+ <p>Unique id of routing instance</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ site-pair-id
+ </td>
+ <td>
+ <p>unique identifier of probe</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cos
+ </td>
+ <td>
+ <p>unique identifier of probe</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ site-pair-set-id
+ </td>
+ <td>
+ <p>Unique id of site pair set.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ routing-instance-id
+ </td>
+ <td>
+ <p>Unique id of routing instance</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ site-pair-id
+ </td>
+ <td>
+ <p>unique identifier of probe</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cos
+ </td>
+ <td>
+ <p>unique identifier of probe</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ site-pair-set-id
+ </td>
+ <td>
+ <p>Unique id of site pair set.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ routing-instance-id
+ </td>
+ <td>
+ <p>Unique id of routing instance</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ site-pair-id
+ </td>
+ <td>
+ <p>unique identifier of probe</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ site-pair-set-id
+ </td>
+ <td>
+ <p>Unique id of site pair set.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ routing-instance-id
+ </td>
+ <td>
+ <p>Unique id of routing instance</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ site-pair-id
+ </td>
+ <td>
+ <p>unique identifier of probe</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vces-"></span>
+ <div id="operation--network-vces-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns vces</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/vces</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns vces</p>
+
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/vces">/vces</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vces-vce--vnf-id--"></span>
+ <div id="operation--network-vces-vce--vnf-id--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns vce</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/vces/vce/{vnf-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns vce</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name
+ </td>
+ <td>
+ <p>Name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name2
+ </td>
+ <td>
+ <p>Alternate name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ regional-resource-zone
+ </td>
+ <td>
+ <p>Regional way of organizing pservers, source of truth should define values</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vpe-id
+ </td>
+ <td>
+ <p>Unique ID of VPE connected to this VCE.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/vce">/vce</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vces-vce--vnf-id--"></span>
+ <div id="operation--network-vces-vce--vnf-id--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing vce</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/vces/vce/{vnf-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing vce</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>vce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVce.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/vce">/vce</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vces-vce--vnf-id--"></span>
+ <div id="operation--network-vces-vce--vnf-id--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing vce</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/vces/vce/{vnf-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing vce</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>vce object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/vce">/vce</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vces-vce--vnf-id--"></span>
+ <div id="operation--network-vces-vce--vnf-id--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing vce</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/vces/vce/{vnf-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing vce</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vces-vce--vnf-id--entitlements-"></span>
+ <div id="operation--network-vces-vce--vnf-id--entitlements-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns entitlements</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/vces/vce/{vnf-id}/entitlements</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns entitlements</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name
+ </td>
+ <td>
+ <p>Name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name2
+ </td>
+ <td>
+ <p>Alternate name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ regional-resource-zone
+ </td>
+ <td>
+ <p>Regional way of organizing pservers, source of truth should define values</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vpe-id
+ </td>
+ <td>
+ <p>Unique ID of VPE connected to this VCE.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/entitlements">/entitlements</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vces-vce--vnf-id--entitlements-entitlement--group-uuid---resource-uuid--"></span>
+ <div id="operation--network-vces-vce--vnf-id--entitlements-entitlement--group-uuid---resource-uuid--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns entitlement</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns entitlement</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ group-uuid
+ </td>
+ <td>
+ <p>Unique ID for the entitlement group the resource comes from, should be uuid.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-uuid
+ </td>
+ <td>
+ <p>Unique ID of an entitlement resource.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name
+ </td>
+ <td>
+ <p>Name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name2
+ </td>
+ <td>
+ <p>Alternate name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ regional-resource-zone
+ </td>
+ <td>
+ <p>Regional way of organizing pservers, source of truth should define values</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vpe-id
+ </td>
+ <td>
+ <p>Unique ID of VPE connected to this VCE.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/entitlement">/entitlement</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vces-vce--vnf-id--entitlements-entitlement--group-uuid---resource-uuid--"></span>
+ <div id="operation--network-vces-vce--vnf-id--entitlements-entitlement--group-uuid---resource-uuid--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing entitlement</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing entitlement</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVceEntitlementsEntitlement.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/entitlement">/entitlement</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ group-uuid
+ </td>
+ <td>
+ <p>Unique ID for the entitlement group the resource comes from, should be uuid.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-uuid
+ </td>
+ <td>
+ <p>Unique ID of an entitlement resource.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vces-vce--vnf-id--entitlements-entitlement--group-uuid---resource-uuid--"></span>
+ <div id="operation--network-vces-vce--vnf-id--entitlements-entitlement--group-uuid---resource-uuid--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing entitlement</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing entitlement</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>entitlement object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/entitlement">/entitlement</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ group-uuid
+ </td>
+ <td>
+ <p>Unique ID for the entitlement group the resource comes from, should be uuid.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-uuid
+ </td>
+ <td>
+ <p>Unique ID of an entitlement resource.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vces-vce--vnf-id--entitlements-entitlement--group-uuid---resource-uuid--"></span>
+ <div id="operation--network-vces-vce--vnf-id--entitlements-entitlement--group-uuid---resource-uuid--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing entitlement</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing entitlement</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ group-uuid
+ </td>
+ <td>
+ <p>Unique ID for the entitlement group the resource comes from, should be uuid.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-uuid
+ </td>
+ <td>
+ <p>Unique ID of an entitlement resource.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vces-vce--vnf-id--entitlements-entitlement--group-uuid---resource-uuid--relationship-list-relationship-"></span>
+ <div id="operation--network-vces-vce--vnf-id--entitlements-entitlement--group-uuid---resource-uuid--relationship-list-relationship-put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVceEntitlementsEntitlement.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ group-uuid
+ </td>
+ <td>
+ <p>Unique ID for the entitlement group the resource comes from, should be uuid.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-uuid
+ </td>
+ <td>
+ <p>Unique ID of an entitlement resource.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vces-vce--vnf-id--entitlements-entitlement--group-uuid---resource-uuid--relationship-list-relationship-"></span>
+ <div id="operation--network-vces-vce--vnf-id--entitlements-entitlement--group-uuid---resource-uuid--relationship-list-relationship-delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ group-uuid
+ </td>
+ <td>
+ <p>Unique ID for the entitlement group the resource comes from, should be uuid.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-uuid
+ </td>
+ <td>
+ <p>Unique ID of an entitlement resource.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vces-vce--vnf-id--licenses-"></span>
+ <div id="operation--network-vces-vce--vnf-id--licenses-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns licenses</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/vces/vce/{vnf-id}/licenses</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns licenses</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name
+ </td>
+ <td>
+ <p>Name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name2
+ </td>
+ <td>
+ <p>Alternate name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ regional-resource-zone
+ </td>
+ <td>
+ <p>Regional way of organizing pservers, source of truth should define values</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vpe-id
+ </td>
+ <td>
+ <p>Unique ID of VPE connected to this VCE.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/licenses">/licenses</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vces-vce--vnf-id--licenses-license--group-uuid---resource-uuid--"></span>
+ <div id="operation--network-vces-vce--vnf-id--licenses-license--group-uuid---resource-uuid--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns license</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns license</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ group-uuid
+ </td>
+ <td>
+ <p>Unique ID for the license group the resource belongs to, should be uuid.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-uuid
+ </td>
+ <td>
+ <p>Unique ID of a license resource.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name
+ </td>
+ <td>
+ <p>Name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name2
+ </td>
+ <td>
+ <p>Alternate name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ regional-resource-zone
+ </td>
+ <td>
+ <p>Regional way of organizing pservers, source of truth should define values</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vpe-id
+ </td>
+ <td>
+ <p>Unique ID of VPE connected to this VCE.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/license">/license</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vces-vce--vnf-id--licenses-license--group-uuid---resource-uuid--"></span>
+ <div id="operation--network-vces-vce--vnf-id--licenses-license--group-uuid---resource-uuid--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing license</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing license</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVceLicensesLicense.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/license">/license</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ group-uuid
+ </td>
+ <td>
+ <p>Unique ID for the license group the resource belongs to, should be uuid.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-uuid
+ </td>
+ <td>
+ <p>Unique ID of a license resource.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vces-vce--vnf-id--licenses-license--group-uuid---resource-uuid--"></span>
+ <div id="operation--network-vces-vce--vnf-id--licenses-license--group-uuid---resource-uuid--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing license</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing license</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>license object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/license">/license</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ group-uuid
+ </td>
+ <td>
+ <p>Unique ID for the license group the resource belongs to, should be uuid.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-uuid
+ </td>
+ <td>
+ <p>Unique ID of a license resource.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vces-vce--vnf-id--licenses-license--group-uuid---resource-uuid--"></span>
+ <div id="operation--network-vces-vce--vnf-id--licenses-license--group-uuid---resource-uuid--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing license</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing license</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ group-uuid
+ </td>
+ <td>
+ <p>Unique ID for the license group the resource belongs to, should be uuid.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-uuid
+ </td>
+ <td>
+ <p>Unique ID of a license resource.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vces-vce--vnf-id--licenses-license--group-uuid---resource-uuid--relationship-list-relationship-"></span>
+ <div id="operation--network-vces-vce--vnf-id--licenses-license--group-uuid---resource-uuid--relationship-list-relationship-put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVceLicensesLicense.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ group-uuid
+ </td>
+ <td>
+ <p>Unique ID for the license group the resource belongs to, should be uuid.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-uuid
+ </td>
+ <td>
+ <p>Unique ID of a license resource.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vces-vce--vnf-id--licenses-license--group-uuid---resource-uuid--relationship-list-relationship-"></span>
+ <div id="operation--network-vces-vce--vnf-id--licenses-license--group-uuid---resource-uuid--relationship-list-relationship-delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ group-uuid
+ </td>
+ <td>
+ <p>Unique ID for the license group the resource belongs to, should be uuid.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-uuid
+ </td>
+ <td>
+ <p>Unique ID of a license resource.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vces-vce--vnf-id--port-groups-"></span>
+ <div id="operation--network-vces-vce--vnf-id--port-groups-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns port-groups</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/vces/vce/{vnf-id}/port-groups</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns port-groups</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name
+ </td>
+ <td>
+ <p>Name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name2
+ </td>
+ <td>
+ <p>Alternate name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ regional-resource-zone
+ </td>
+ <td>
+ <p>Regional way of organizing pservers, source of truth should define values</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vpe-id
+ </td>
+ <td>
+ <p>Unique ID of VPE connected to this VCE.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/port-groups">/port-groups</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vces-vce--vnf-id--port-groups-port-group--interface-id--"></span>
+ <div id="operation--network-vces-vce--vnf-id--port-groups-port-group--interface-id--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns port-group</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns port-group</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>Unique ID of the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name
+ </td>
+ <td>
+ <p>Name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name2
+ </td>
+ <td>
+ <p>Alternate name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ regional-resource-zone
+ </td>
+ <td>
+ <p>Regional way of organizing pservers, source of truth should define values</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vpe-id
+ </td>
+ <td>
+ <p>Unique ID of VPE connected to this VCE.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ port-group-id
+ </td>
+ <td>
+ <p>Unique ID for port group in vmware</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ switch-name
+ </td>
+ <td>
+ <p>DVS or standard switch name (should be non-null for port groups associated with DVS)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/port-group">/port-group</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vces-vce--vnf-id--port-groups-port-group--interface-id--"></span>
+ <div id="operation--network-vces-vce--vnf-id--port-groups-port-group--interface-id--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing port-group</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing port-group</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>port-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVcePortGroupsPortGroup.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/port-group">/port-group</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>Unique ID of the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vces-vce--vnf-id--port-groups-port-group--interface-id--"></span>
+ <div id="operation--network-vces-vce--vnf-id--port-groups-port-group--interface-id--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing port-group</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing port-group</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>port-group object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/port-group">/port-group</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>Unique ID of the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vces-vce--vnf-id--port-groups-port-group--interface-id--"></span>
+ <div id="operation--network-vces-vce--vnf-id--port-groups-port-group--interface-id--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing port-group</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing port-group</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>Unique ID of the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vces-vce--vnf-id--port-groups-port-group--interface-id--cvlan-tags-"></span>
+ <div id="operation--network-vces-vce--vnf-id--port-groups-port-group--interface-id--cvlan-tags-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns cvlan-tags</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns cvlan-tags</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>Unique ID of the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name
+ </td>
+ <td>
+ <p>Name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name2
+ </td>
+ <td>
+ <p>Alternate name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ regional-resource-zone
+ </td>
+ <td>
+ <p>Regional way of organizing pservers, source of truth should define values</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vpe-id
+ </td>
+ <td>
+ <p>Unique ID of VPE connected to this VCE.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ port-group-id
+ </td>
+ <td>
+ <p>Unique ID for port group in vmware</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ switch-name
+ </td>
+ <td>
+ <p>DVS or standard switch name (should be non-null for port groups associated with DVS)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/cvlan-tags">/cvlan-tags</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vces-vce--vnf-id--port-groups-port-group--interface-id--cvlan-tags-cvlan-tag-entry--cvlan-tag--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns cvlan-tag-entry</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns cvlan-tag-entry</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>Unique ID of the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cvlan-tag
+ </td>
+ <td>
+ <p>See mis-na-virtualization-platform.yang</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name
+ </td>
+ <td>
+ <p>Name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-name2
+ </td>
+ <td>
+ <p>Alternate name of VNF.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ regional-resource-zone
+ </td>
+ <td>
+ <p>Regional way of organizing pservers, source of truth should define values</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vpe-id
+ </td>
+ <td>
+ <p>Unique ID of VPE connected to this VCE.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ port-group-id
+ </td>
+ <td>
+ <p>Unique ID for port group in vmware</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ switch-name
+ </td>
+ <td>
+ <p>DVS or standard switch name (should be non-null for port groups associated with DVS)</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ heat-stack-id
+ </td>
+ <td>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/cvlan-tag-entry">/cvlan-tag-entry</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vces-vce--vnf-id--port-groups-port-group--interface-id--cvlan-tags-cvlan-tag-entry--cvlan-tag--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing cvlan-tag-entry</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing cvlan-tag-entry</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>cvlan-tag-entry object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/cvlan-tag-entry">/cvlan-tag-entry</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>Unique ID of the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cvlan-tag
+ </td>
+ <td>
+ <p>See mis-na-virtualization-platform.yang</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vces-vce--vnf-id--port-groups-port-group--interface-id--cvlan-tags-cvlan-tag-entry--cvlan-tag--"></span>
+ <div id="operation--network-vces-vce--vnf-id--port-groups-port-group--interface-id--cvlan-tags-cvlan-tag-entry--cvlan-tag--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing cvlan-tag-entry</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing cvlan-tag-entry</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>cvlan-tag-entry object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/cvlan-tag-entry">/cvlan-tag-entry</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>Unique ID of the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cvlan-tag
+ </td>
+ <td>
+ <p>See mis-na-virtualization-platform.yang</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vces-vce--vnf-id--port-groups-port-group--interface-id--cvlan-tags-cvlan-tag-entry--cvlan-tag--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing cvlan-tag-entry</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing cvlan-tag-entry</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>Unique ID of the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cvlan-tag
+ </td>
+ <td>
+ <p>See mis-na-virtualization-platform.yang</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vces-vce--vnf-id--port-groups-port-group--interface-id--cvlan-tags-cvlan-tag-entry--cvlan-tag--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>Unique ID of the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cvlan-tag
+ </td>
+ <td>
+ <p>See mis-na-virtualization-platform.yang</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vces-vce--vnf-id--port-groups-port-group--interface-id--cvlan-tags-cvlan-tag-entry--cvlan-tag--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>Unique ID of the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ cvlan-tag
+ </td>
+ <td>
+ <p>See mis-na-virtualization-platform.yang</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vces-vce--vnf-id--port-groups-port-group--interface-id--relationship-list-relationship-"></span>
+ <div id="operation--network-vces-vce--vnf-id--port-groups-port-group--interface-id--relationship-list-relationship-put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVcePortGroupsPortGroup.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>Unique ID of the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vces-vce--vnf-id--port-groups-port-group--interface-id--relationship-list-relationship-"></span>
+ <div id="operation--network-vces-vce--vnf-id--port-groups-port-group--interface-id--relationship-list-relationship-delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>Unique ID of the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vces-vce--vnf-id--relationship-list-relationship-"></span>
+ <div id="operation--network-vces-vce--vnf-id--relationship-list-relationship-put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/vces/vce/{vnf-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVce.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vces-vce--vnf-id--relationship-list-relationship-"></span>
+ <div id="operation--network-vces-vce--vnf-id--relationship-list-relationship-delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/vces/vce/{vnf-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-id
+ </td>
+ <td>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vnfcs-"></span>
+ <div id="operation--network-vnfcs-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns vnfcs</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/vnfcs</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns vnfcs</p>
+
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/vnfcs">/vnfcs</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vnfcs-vnfc--vnfc-name--"></span>
+ <div id="operation--network-vnfcs-vnfc--vnfc-name--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns vnfc</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/vnfcs/vnfc/{vnfc-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns vnfc</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnfc-name
+ </td>
+ <td>
+ <p>Unique ID of vnfc.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nfc-naming-code
+ </td>
+ <td>
+ <p>Short code that is used in naming instances of the item being modeled</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nfc-function
+ </td>
+ <td>
+ <p>English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>prov status of this vnfc</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ ipaddress-v4-oam-vip
+ </td>
+ <td>
+ <p>Oam V4 vip address of this vnfc</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ is-closed-loop-disabled
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ group-notation
+ </td>
+ <td>
+ <p>Group notation of VNFC</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/vnfc">/vnfc</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vnfcs-vnfc--vnfc-name--"></span>
+ <div id="operation--network-vnfcs-vnfc--vnfc-name--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing vnfc</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/vnfcs/vnfc/{vnfc-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing vnfc</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>vnfc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVnfcsVnfc.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/vnfc">/vnfc</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnfc-name
+ </td>
+ <td>
+ <p>Unique ID of vnfc.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vnfcs-vnfc--vnfc-name--"></span>
+ <div id="operation--network-vnfcs-vnfc--vnfc-name--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing vnfc</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/vnfcs/vnfc/{vnfc-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing vnfc</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>vnfc object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/vnfc">/vnfc</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnfc-name
+ </td>
+ <td>
+ <p>Unique ID of vnfc.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vnfcs-vnfc--vnfc-name--"></span>
+ <div id="operation--network-vnfcs-vnfc--vnfc-name--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing vnfc</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/vnfcs/vnfc/{vnfc-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing vnfc</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnfc-name
+ </td>
+ <td>
+ <p>Unique ID of vnfc.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vnfcs-vnfc--vnfc-name--l3-interface-ipv4-address-list--l3-interface-ipv4-address--"></span>
+ <div id="operation--network-vnfcs-vnfc--vnfc-name--l3-interface-ipv4-address-list--l3-interface-ipv4-address--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnfc-name
+ </td>
+ <td>
+ <p>Unique ID of vnfc.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nfc-naming-code
+ </td>
+ <td>
+ <p>Short code that is used in naming instances of the item being modeled</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nfc-function
+ </td>
+ <td>
+ <p>English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>prov status of this vnfc</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ ipaddress-v4-oam-vip
+ </td>
+ <td>
+ <p>Oam V4 vip address of this vnfc</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ is-closed-loop-disabled
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ group-notation
+ </td>
+ <td>
+ <p>Group notation of VNFC</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-subnet-id
+ </td>
+ <td>
+ <p>Neutron id of subnet that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vnfcs-vnfc--vnfc-name--l3-interface-ipv4-address-list--l3-interface-ipv4-address--"></span>
+ <div id="operation--network-vnfcs-vnfc--vnfc-name--l3-interface-ipv4-address-list--l3-interface-ipv4-address--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVnfcsVnfcL3InterfaceIpv4AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnfc-name
+ </td>
+ <td>
+ <p>Unique ID of vnfc.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vnfcs-vnfc--vnfc-name--l3-interface-ipv4-address-list--l3-interface-ipv4-address--"></span>
+ <div id="operation--network-vnfcs-vnfc--vnfc-name--l3-interface-ipv4-address-list--l3-interface-ipv4-address--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv4-address-list object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnfc-name
+ </td>
+ <td>
+ <p>Unique ID of vnfc.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vnfcs-vnfc--vnfc-name--l3-interface-ipv4-address-list--l3-interface-ipv4-address--"></span>
+ <div id="operation--network-vnfcs-vnfc--vnfc-name--l3-interface-ipv4-address-list--l3-interface-ipv4-address--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnfc-name
+ </td>
+ <td>
+ <p>Unique ID of vnfc.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vnfcs-vnfc--vnfc-name--l3-interface-ipv4-address-list--l3-interface-ipv4-address--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVnfcsVnfcL3InterfaceIpv4AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnfc-name
+ </td>
+ <td>
+ <p>Unique ID of vnfc.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vnfcs-vnfc--vnfc-name--l3-interface-ipv4-address-list--l3-interface-ipv4-address--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnfc-name
+ </td>
+ <td>
+ <p>Unique ID of vnfc.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vnfcs-vnfc--vnfc-name--l3-interface-ipv6-address-list--l3-interface-ipv6-address--"></span>
+ <div id="operation--network-vnfcs-vnfc--vnfc-name--l3-interface-ipv6-address-list--l3-interface-ipv6-address--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnfc-name
+ </td>
+ <td>
+ <p>Unique ID of vnfc.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nfc-naming-code
+ </td>
+ <td>
+ <p>Short code that is used in naming instances of the item being modeled</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ nfc-function
+ </td>
+ <td>
+ <p>English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>prov status of this vnfc</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ ipaddress-v4-oam-vip
+ </td>
+ <td>
+ <p>Oam V4 vip address of this vnfc</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ in-maint
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ is-closed-loop-disabled
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ group-notation
+ </td>
+ <td>
+ <p>Group notation of VNFC</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>the ASDC model id for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>the ASDC model version for this resource or service model.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-subnet-id
+ </td>
+ <td>
+ <p>Neutron id of subnet that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vnfcs-vnfc--vnfc-name--l3-interface-ipv6-address-list--l3-interface-ipv6-address--"></span>
+ <div id="operation--network-vnfcs-vnfc--vnfc-name--l3-interface-ipv6-address-list--l3-interface-ipv6-address--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVnfcsVnfcL3InterfaceIpv6AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnfc-name
+ </td>
+ <td>
+ <p>Unique ID of vnfc.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vnfcs-vnfc--vnfc-name--l3-interface-ipv6-address-list--l3-interface-ipv6-address--"></span>
+ <div id="operation--network-vnfcs-vnfc--vnfc-name--l3-interface-ipv6-address-list--l3-interface-ipv6-address--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv6-address-list object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnfc-name
+ </td>
+ <td>
+ <p>Unique ID of vnfc.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vnfcs-vnfc--vnfc-name--l3-interface-ipv6-address-list--l3-interface-ipv6-address--"></span>
+ <div id="operation--network-vnfcs-vnfc--vnfc-name--l3-interface-ipv6-address-list--l3-interface-ipv6-address--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnfc-name
+ </td>
+ <td>
+ <p>Unique ID of vnfc.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vnfcs-vnfc--vnfc-name--l3-interface-ipv6-address-list--l3-interface-ipv6-address--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVnfcsVnfcL3InterfaceIpv6AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnfc-name
+ </td>
+ <td>
+ <p>Unique ID of vnfc.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vnfcs-vnfc--vnfc-name--l3-interface-ipv6-address-list--l3-interface-ipv6-address--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnfc-name
+ </td>
+ <td>
+ <p>Unique ID of vnfc.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vnfcs-vnfc--vnfc-name--relationship-list-relationship-"></span>
+ <div id="operation--network-vnfcs-vnfc--vnfc-name--relationship-list-relationship-put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVnfcsVnfc.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnfc-name
+ </td>
+ <td>
+ <p>Unique ID of vnfc.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vnfcs-vnfc--vnfc-name--relationship-list-relationship-"></span>
+ <div id="operation--network-vnfcs-vnfc--vnfc-name--relationship-list-relationship-delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnfc-name
+ </td>
+ <td>
+ <p>Unique ID of vnfc.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-"></span>
+ <div id="operation--network-vpls-pes-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns vpls-pes</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/vpls-pes</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns vpls-pes</p>
+
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/vpls-pes">/vpls-pes</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--"></span>
+ <div id="operation--network-vpls-pes-vpls-pe--equipment-name--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns vpls-pe</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns vpls-pe</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this VNF by BAU Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/vpls-pe">/vpls-pe</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--"></span>
+ <div id="operation--network-vpls-pes-vpls-pe--equipment-name--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing vpls-pe</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing vpls-pe</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>vpls-pe object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPe.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/vpls-pe">/vpls-pe</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--"></span>
+ <div id="operation--network-vpls-pes-vpls-pe--equipment-name--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing vpls-pe</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing vpls-pe</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>vpls-pe object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/vpls-pe">/vpls-pe</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--"></span>
+ <div id="operation--network-vpls-pes-vpls-pe--equipment-name--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing vpls-pe</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing vpls-pe</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-"></span>
+ <div id="operation--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns lag-interfaces</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns lag-interfaces</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this VNF by BAU Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/lag-interfaces">/lag-interfaces</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--"></span>
+ <div id="operation--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns lag-interface</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns lag-interface</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this VNF by BAU Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-role
+ </td>
+ <td>
+ <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/lag-interface">/lag-interface</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--"></span>
+ <div id="operation--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing lag-interface</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing lag-interface</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/lag-interface">/lag-interface</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--"></span>
+ <div id="operation--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing lag-interface</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing lag-interface</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>lag-interface object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/lag-interface">/lag-interface</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--"></span>
+ <div id="operation--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing lag-interface</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing lag-interface</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--l-interfaces-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l-interfaces</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l-interfaces</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this VNF by BAU Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-role
+ </td>
+ <td>
+ <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l-interfaces">/l-interfaces</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l-interface</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l-interface</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this VNF by BAU Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-role
+ </td>
+ <td>
+ <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l-interface">/l-interface</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l-interface</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l-interface</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l-interface">/l-interface</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--"></span>
+ <div id="operation--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l-interface</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l-interface</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l-interface object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l-interface">/l-interface</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l-interface</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l-interface</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this VNF by BAU Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-role
+ </td>
+ <td>
+ <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-subnet-id
+ </td>
+ <td>
+ <p>Neutron id of subnet that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv4-address-list object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this VNF by BAU Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-role
+ </td>
+ <td>
+ <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-subnet-id
+ </td>
+ <td>
+ <p>Neutron id of subnet that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv6-address-list object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns sriov-vfs</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns sriov-vfs</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this VNF by BAU Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-role
+ </td>
+ <td>
+ <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/sriov-vfs">/sriov-vfs</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns sriov-vf</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns sriov-vf</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this VNF by BAU Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-role
+ </td>
+ <td>
+ <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vf-vlan-filter
+ </td>
+ <td>
+ <p>This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vf-mac-filter
+ </td>
+ <td>
+ <p>When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vf-vlan-strip
+ </td>
+ <td>
+ <p>When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/sriov-vf">/sriov-vf</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing sriov-vf</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing sriov-vf</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/sriov-vf">/sriov-vf</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing sriov-vf</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing sriov-vf</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>sriov-vf object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/sriov-vf">/sriov-vf</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing sriov-vf</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing sriov-vf</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns vlans</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns vlans</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this VNF by BAU Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-role
+ </td>
+ <td>
+ <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/vlans">/vlans</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns vlan</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns vlan</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this VNF by BAU Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-role
+ </td>
+ <td>
+ <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vpn-key
+ </td>
+ <td>
+ <p>This indicates the customers VPN ID associated with this vlan</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/vlan">/vlan</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing vlan</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing vlan</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/vlan">/vlan</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing vlan</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing vlan</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>vlan object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/vlan">/vlan</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing vlan</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing vlan</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this VNF by BAU Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-role
+ </td>
+ <td>
+ <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vpn-key
+ </td>
+ <td>
+ <p>This indicates the customers VPN ID associated with this vlan</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-subnet-id
+ </td>
+ <td>
+ <p>Neutron id of subnet that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv4-address-list object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this VNF by BAU Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-role
+ </td>
+ <td>
+ <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vpn-key
+ </td>
+ <td>
+ <p>This indicates the customers VPN ID associated with this vlan</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-subnet-id
+ </td>
+ <td>
+ <p>Neutron id of subnet that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv6-address-list object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the link aggregate interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-"></span>
+ <div id="operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns p-interfaces</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns p-interfaces</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this VNF by BAU Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/p-interfaces">/p-interfaces</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--"></span>
+ <div id="operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns p-interface</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns p-interface</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this VNF by BAU Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/p-interface">/p-interface</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--"></span>
+ <div id="operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing p-interface</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing p-interface</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterface.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/p-interface">/p-interface</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--"></span>
+ <div id="operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing p-interface</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing p-interface</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>p-interface object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/p-interface">/p-interface</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--"></span>
+ <div id="operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing p-interface</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing p-interface</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--l-interfaces-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l-interfaces</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l-interfaces</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this VNF by BAU Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l-interfaces">/l-interfaces</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l-interface</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l-interface</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this VNF by BAU Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l-interface">/l-interface</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l-interface</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l-interface</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l-interface">/l-interface</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--"></span>
+ <div id="operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l-interface</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l-interface</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l-interface object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l-interface">/l-interface</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l-interface</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l-interface</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this VNF by BAU Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-subnet-id
+ </td>
+ <td>
+ <p>Neutron id of subnet that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv4-address-list object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this VNF by BAU Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-subnet-id
+ </td>
+ <td>
+ <p>Neutron id of subnet that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv6-address-list object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns sriov-vfs</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns sriov-vfs</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this VNF by BAU Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/sriov-vfs">/sriov-vfs</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns sriov-vf</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns sriov-vf</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this VNF by BAU Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vf-vlan-filter
+ </td>
+ <td>
+ <p>This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vf-mac-filter
+ </td>
+ <td>
+ <p>When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vf-vlan-strip
+ </td>
+ <td>
+ <p>When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/sriov-vf">/sriov-vf</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing sriov-vf</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing sriov-vf</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/sriov-vf">/sriov-vf</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing sriov-vf</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing sriov-vf</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>sriov-vf object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/sriov-vf">/sriov-vf</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing sriov-vf</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing sriov-vf</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pci-id
+ </td>
+ <td>
+ <p>PCI ID used to identify the sriov-vf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns vlans</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns vlans</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this VNF by BAU Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/vlans">/vlans</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns vlan</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns vlan</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this VNF by BAU Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vpn-key
+ </td>
+ <td>
+ <p>This indicates the customers VPN ID associated with this vlan</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/vlan">/vlan</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing vlan</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing vlan</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/vlan">/vlan</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing vlan</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing vlan</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>vlan object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/vlan">/vlan</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing vlan</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing vlan</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this VNF by BAU Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vpn-key
+ </td>
+ <td>
+ <p>This indicates the customers VPN ID associated with this vlan</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-subnet-id
+ </td>
+ <td>
+ <p>Neutron id of subnet that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv4-address-list object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l3-interface-ipv4-address-list">/l3-interface-ipv4-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l3-interface-ipv4-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l3-interface-ipv4-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv4-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this VNF by BAU Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-id
+ </td>
+ <td>
+ <p>ID of interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ macaddr
+ </td>
+ <td>
+ <p>MAC address for the interface</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ network-name
+ </td>
+ <td>
+ <p>Name of the network</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vpn-key
+ </td>
+ <td>
+ <p>This indicates the customers VPN ID associated with this vlan</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-id-inner
+ </td>
+ <td>
+ <p>Inner VLAN tag</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-network-id
+ </td>
+ <td>
+ <p>Neutron network id of the interface that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ neutron-subnet-id
+ </td>
+ <td>
+ <p>Neutron id of subnet that address belongs to</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>l3-interface-ipv6-address-list object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/l3-interface-ipv6-address-list">/l3-interface-ipv6-address-list</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing l3-interface-ipv6-address-list</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing l3-interface-ipv6-address-list</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ l3-interface-ipv6-address
+ </td>
+ <td>
+ <p>IP address</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name given to the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vlan-interface
+ </td>
+ <td>
+ <p>String that identifies the interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterface.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--sriov-pfs-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns sriov-pfs</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns sriov-pfs</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this VNF by BAU Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/sriov-pfs">/sriov-pfs</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns sriov-pf</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns sriov-pf</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pf-pci-id
+ </td>
+ <td>
+ <p>Identifier for the sriov-pf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this VNF by BAU Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ prov-status
+ </td>
+ <td>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/sriov-pf">/sriov-pf</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing sriov-pf</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing sriov-pf</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/sriov-pf">/sriov-pf</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pf-pci-id
+ </td>
+ <td>
+ <p>Identifier for the sriov-pf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--"></span>
+ <div id="operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing sriov-pf</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing sriov-pf</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>sriov-pf object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/sriov-pf">/sriov-pf</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pf-pci-id
+ </td>
+ <td>
+ <p>Identifier for the sriov-pf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing sriov-pf</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing sriov-pf</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pf-pci-id
+ </td>
+ <td>
+ <p>Identifier for the sriov-pf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pf-pci-id
+ </td>
+ <td>
+ <p>Identifier for the sriov-pf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ interface-name
+ </td>
+ <td>
+ <p>Name that identifies the physical interface</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ pf-pci-id
+ </td>
+ <td>
+ <p>Identifier for the sriov-pf</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--relationship-list-relationship-"></span>
+ <div id="operation--network-vpls-pes-vpls-pe--equipment-name--relationship-list-relationship-put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPe.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpls-pes-vpls-pe--equipment-name--relationship-list-relationship-"></span>
+ <div id="operation--network-vpls-pes-vpls-pe--equipment-name--relationship-list-relationship-delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ equipment-name
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpn-bindings-"></span>
+ <div id="operation--network-vpn-bindings-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns vpn-bindings</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/vpn-bindings</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns vpn-bindings</p>
+
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/vpn-bindings">/vpn-bindings</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpn-bindings-vpn-binding--vpn-id--"></span>
+ <div id="operation--network-vpn-bindings-vpn-binding--vpn-id--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns vpn-binding</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/vpn-bindings/vpn-binding/{vpn-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns vpn-binding</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vpn-id
+ </td>
+ <td>
+ <p>VPN ID, globally unique within A&AI</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vpn-name
+ </td>
+ <td>
+ <p>VPN Name</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vpn-type
+ </td>
+ <td>
+ <p>Type of the vpn, should be taken from enumerated/valid values</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/vpn-binding">/vpn-binding</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpn-bindings-vpn-binding--vpn-id--"></span>
+ <div id="operation--network-vpn-bindings-vpn-binding--vpn-id--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing vpn-binding</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/vpn-bindings/vpn-binding/{vpn-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing vpn-binding</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>vpn-binding object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVpnBindingsVpnBinding.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/vpn-binding">/vpn-binding</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vpn-id
+ </td>
+ <td>
+ <p>VPN ID, globally unique within A&AI</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpn-bindings-vpn-binding--vpn-id--"></span>
+ <div id="operation--network-vpn-bindings-vpn-binding--vpn-id--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing vpn-binding</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/vpn-bindings/vpn-binding/{vpn-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing vpn-binding</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>vpn-binding object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/vpn-binding">/vpn-binding</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vpn-id
+ </td>
+ <td>
+ <p>VPN ID, globally unique within A&AI</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpn-bindings-vpn-binding--vpn-id--"></span>
+ <div id="operation--network-vpn-bindings-vpn-binding--vpn-id--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing vpn-binding</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/vpn-bindings/vpn-binding/{vpn-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing vpn-binding</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vpn-id
+ </td>
+ <td>
+ <p>VPN ID, globally unique within A&AI</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpn-bindings-vpn-binding--vpn-id--relationship-list-relationship-"></span>
+ <div id="operation--network-vpn-bindings-vpn-binding--vpn-id--relationship-list-relationship-put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVpnBindingsVpnBinding.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vpn-id
+ </td>
+ <td>
+ <p>VPN ID, globally unique within A&AI</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpn-bindings-vpn-binding--vpn-id--relationship-list-relationship-"></span>
+ <div id="operation--network-vpn-bindings-vpn-binding--vpn-id--relationship-list-relationship-delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vpn-id
+ </td>
+ <td>
+ <p>VPN ID, globally unique within A&AI</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpn-bindings-vpn-binding--vpn-id--route-targets-"></span>
+ <div id="operation--network-vpn-bindings-vpn-binding--vpn-id--route-targets-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns route-targets</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/vpn-bindings/vpn-binding/{vpn-id}/route-targets</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns route-targets</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vpn-id
+ </td>
+ <td>
+ <p>VPN ID, globally unique within A&AI</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vpn-name
+ </td>
+ <td>
+ <p>VPN Name</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vpn-type
+ </td>
+ <td>
+ <p>Type of the vpn, should be taken from enumerated/valid values</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/route-targets">/route-targets</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpn-bindings-vpn-binding--vpn-id--route-targets-route-target--global-route-target---route-target-role--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns route-target</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns route-target</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vpn-id
+ </td>
+ <td>
+ <p>VPN ID, globally unique within A&AI</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ global-route-target
+ </td>
+ <td>
+ <p>Number used to identify an RT, globally unique in the network</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ route-target-role
+ </td>
+ <td>
+ <p>Role assigned to this route target</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vpn-name
+ </td>
+ <td>
+ <p>VPN Name</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vpn-type
+ </td>
+ <td>
+ <p>Type of the vpn, should be taken from enumerated/valid values</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/route-target">/route-target</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpn-bindings-vpn-binding--vpn-id--route-targets-route-target--global-route-target---route-target-role--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing route-target</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing route-target</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>route-target object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/route-target">/route-target</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vpn-id
+ </td>
+ <td>
+ <p>VPN ID, globally unique within A&AI</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ global-route-target
+ </td>
+ <td>
+ <p>Number used to identify an RT, globally unique in the network</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ route-target-role
+ </td>
+ <td>
+ <p>Role assigned to this route target</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpn-bindings-vpn-binding--vpn-id--route-targets-route-target--global-route-target---route-target-role--"></span>
+ <div id="operation--network-vpn-bindings-vpn-binding--vpn-id--route-targets-route-target--global-route-target---route-target-role--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing route-target</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing route-target</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>route-target object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/route-target">/route-target</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vpn-id
+ </td>
+ <td>
+ <p>VPN ID, globally unique within A&AI</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ global-route-target
+ </td>
+ <td>
+ <p>Number used to identify an RT, globally unique in the network</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ route-target-role
+ </td>
+ <td>
+ <p>Role assigned to this route target</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpn-bindings-vpn-binding--vpn-id--route-targets-route-target--global-route-target---route-target-role--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing route-target</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing route-target</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vpn-id
+ </td>
+ <td>
+ <p>VPN ID, globally unique within A&AI</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ global-route-target
+ </td>
+ <td>
+ <p>Number used to identify an RT, globally unique in the network</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ route-target-role
+ </td>
+ <td>
+ <p>Role assigned to this route target</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpn-bindings-vpn-binding--vpn-id--route-targets-route-target--global-route-target---route-target-role--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vpn-id
+ </td>
+ <td>
+ <p>VPN ID, globally unique within A&AI</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ global-route-target
+ </td>
+ <td>
+ <p>Number used to identify an RT, globally unique in the network</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ route-target-role
+ </td>
+ <td>
+ <p>Role assigned to this route target</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-vpn-bindings-vpn-binding--vpn-id--route-targets-route-target--global-route-target---route-target-role--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vpn-id
+ </td>
+ <td>
+ <p>VPN ID, globally unique within A&AI</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ global-route-target
+ </td>
+ <td>
+ <p>Number used to identify an RT, globally unique in the network</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ route-target-role
+ </td>
+ <td>
+ <p>Role assigned to this route target</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-zones-"></span>
+ <div id="operation--network-zones-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns zones</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/zones</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns zones</p>
+
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/zones">/zones</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-zones-zone--zone-id--"></span>
+ <div id="operation--network-zones-zone--zone-id--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns zone</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/network/zones/zone/{zone-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns zone</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ zone-id
+ </td>
+ <td>
+ <p>Code assigned by AIC to the zone</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ design-type
+ </td>
+ <td>
+ <p>Design of zone [Medium/Largeā€¦]</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ zone-context
+ </td>
+ <td>
+ <p>Context of zone [production/test]</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/zone">/zone</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-zones-zone--zone-id--"></span>
+ <div id="operation--network-zones-zone--zone-id--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing zone</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/zones/zone/{zone-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing zone</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkZonesZone.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/zone">/zone</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ zone-id
+ </td>
+ <td>
+ <p>Code assigned by AIC to the zone</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-zones-zone--zone-id--"></span>
+ <div id="operation--network-zones-zone--zone-id--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing zone</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/network/zones/zone/{zone-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing zone</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>zone object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/zone">/zone</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ zone-id
+ </td>
+ <td>
+ <p>Code assigned by AIC to the zone</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-zones-zone--zone-id--"></span>
+ <div id="operation--network-zones-zone--zone-id--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing zone</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/zones/zone/{zone-id}</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing zone</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ zone-id
+ </td>
+ <td>
+ <p>Code assigned by AIC to the zone</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-zones-zone--zone-id--relationship-list-relationship-"></span>
+ <div id="operation--network-zones-zone--zone-id--relationship-list-relationship-put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/network/zones/zone/{zone-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkZonesZone.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ zone-id
+ </td>
+ <td>
+ <p>Code assigned by AIC to the zone</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--network-zones-zone--zone-id--relationship-list-relationship-"></span>
+ <div id="operation--network-zones-zone--zone-id--relationship-list-relationship-delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/network/zones/zone/{zone-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-Network">Network</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ zone-id
+ </td>
+ <td>
+ <p>Code assigned by AIC to the zone</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-models-"></span>
+ <div id="operation--service-design-and-creation-models-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns models</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/service-design-and-creation/models</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns models</p>
+
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/models">/models</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-models-model--model-invariant-id--"></span>
+ <div id="operation--service-design-and-creation-models-model--model-invariant-id--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns model</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/service-design-and-creation/models/model/{model-invariant-id}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns model</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to the main definition of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-type
+ </td>
+ <td>
+ <p>Type of the model, e.g., service, resource, widget, etc.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/model">/model</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-models-model--model-invariant-id--"></span>
+ <div id="operation--service-design-and-creation-models-model--model-invariant-id--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing model</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/service-design-and-creation/models/model/{model-invariant-id}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing model</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>model object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModel.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/model">/model</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to the main definition of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-models-model--model-invariant-id--"></span>
+ <div id="operation--service-design-and-creation-models-model--model-invariant-id--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing model</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/service-design-and-creation/models/model/{model-invariant-id}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing model</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>model object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/model">/model</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to the main definition of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-models-model--model-invariant-id--"></span>
+ <div id="operation--service-design-and-creation-models-model--model-invariant-id--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing model</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/service-design-and-creation/models/model/{model-invariant-id}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing model</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to the main definition of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-models-model--model-invariant-id--model-vers-"></span>
+ <div id="operation--service-design-and-creation-models-model--model-invariant-id--model-vers-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns model-vers</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/service-design-and-creation/models/model/{model-invariant-id}/model-vers</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns model-vers</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to the main definition of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-type
+ </td>
+ <td>
+ <p>Type of the model, e.g., service, resource, widget, etc.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/model-vers">/model-vers</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-models-model--model-invariant-id--model-vers-model-ver--model-version-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns model-ver</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns model-ver</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to the main definition of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to one version of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-type
+ </td>
+ <td>
+ <p>Type of the model, e.g., service, resource, widget, etc.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-name
+ </td>
+ <td>
+ <p>Name of the model, which can change from version to version.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version
+ </td>
+ <td>
+ <p>Version</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ distribution-status
+ </td>
+ <td>
+ <p>Distribution Status</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/model-ver">/model-ver</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-models-model--model-invariant-id--model-vers-model-ver--model-version-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing model-ver</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing model-ver</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>model-ver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVer.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/model-ver">/model-ver</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to the main definition of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to one version of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-models-model--model-invariant-id--model-vers-model-ver--model-version-id--"></span>
+ <div id="operation--service-design-and-creation-models-model--model-invariant-id--model-vers-model-ver--model-version-id--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing model-ver</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing model-ver</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>model-ver object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/model-ver">/model-ver</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to the main definition of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to one version of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-models-model--model-invariant-id--model-vers-model-ver--model-version-id--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing model-ver</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing model-ver</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to the main definition of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to one version of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-models-model--model-invariant-id--model-vers-model-ver--model-version-id--metadata-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns metadata</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns metadata</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to the main definition of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to one version of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-type
+ </td>
+ <td>
+ <p>Type of the model, e.g., service, resource, widget, etc.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-name
+ </td>
+ <td>
+ <p>Name of the model, which can change from version to version.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version
+ </td>
+ <td>
+ <p>Version</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ distribution-status
+ </td>
+ <td>
+ <p>Distribution Status</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/metadata">/metadata</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-models-model--model-invariant-id--model-vers-model-ver--model-version-id--metadata-metadatum--metaname--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns metadatum</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns metadatum</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to the main definition of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to one version of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ metaname
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-type
+ </td>
+ <td>
+ <p>Type of the model, e.g., service, resource, widget, etc.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-name
+ </td>
+ <td>
+ <p>Name of the model, which can change from version to version.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version
+ </td>
+ <td>
+ <p>Version</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ distribution-status
+ </td>
+ <td>
+ <p>Distribution Status</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/metadatum">/metadatum</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-models-model--model-invariant-id--model-vers-model-ver--model-version-id--metadata-metadatum--metaname--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing metadatum</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing metadatum</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/metadatum">/metadatum</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to the main definition of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to one version of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ metaname
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-models-model--model-invariant-id--model-vers-model-ver--model-version-id--metadata-metadatum--metaname--"></span>
+ <div id="operation--service-design-and-creation-models-model--model-invariant-id--model-vers-model-ver--model-version-id--metadata-metadatum--metaname--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing metadatum</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing metadatum</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>metadatum object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/metadatum">/metadatum</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to the main definition of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to one version of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ metaname
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-models-model--model-invariant-id--model-vers-model-ver--model-version-id--metadata-metadatum--metaname--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing metadatum</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing metadatum</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to the main definition of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to one version of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ metaname
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-models-model--model-invariant-id--model-vers-model-ver--model-version-id--model-elements-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns model-elements</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns model-elements</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to the main definition of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to one version of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-type
+ </td>
+ <td>
+ <p>Type of the model, e.g., service, resource, widget, etc.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-name
+ </td>
+ <td>
+ <p>Name of the model, which can change from version to version.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version
+ </td>
+ <td>
+ <p>Version</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ distribution-status
+ </td>
+ <td>
+ <p>Distribution Status</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/model-elements">/model-elements</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-models-model--model-invariant-id--model-vers-model-ver--model-version-id--model-elements-model-element--model-element-uuid--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns model-element</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns model-element</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to the main definition of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to one version of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-element-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-type
+ </td>
+ <td>
+ <p>Type of the model, e.g., service, resource, widget, etc.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-name
+ </td>
+ <td>
+ <p>Name of the model, which can change from version to version.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version
+ </td>
+ <td>
+ <p>Version</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ distribution-status
+ </td>
+ <td>
+ <p>Distribution Status</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/model-element">/model-element</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-models-model--model-invariant-id--model-vers-model-ver--model-version-id--model-elements-model-element--model-element-uuid--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing model-element</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing model-element</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>model-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/model-element">/model-element</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to the main definition of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to one version of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-element-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-models-model--model-invariant-id--model-vers-model-ver--model-version-id--model-elements-model-element--model-element-uuid--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing model-element</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing model-element</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>model-element object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/model-element">/model-element</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to the main definition of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to one version of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-element-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-models-model--model-invariant-id--model-vers-model-ver--model-version-id--model-elements-model-element--model-element-uuid--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing model-element</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing model-element</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to the main definition of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to one version of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-element-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns model-constraints</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns model-constraints</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to the main definition of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to one version of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-element-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-type
+ </td>
+ <td>
+ <p>Type of the model, e.g., service, resource, widget, etc.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-name
+ </td>
+ <td>
+ <p>Name of the model, which can change from version to version.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version
+ </td>
+ <td>
+ <p>Version</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ distribution-status
+ </td>
+ <td>
+ <p>Distribution Status</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/model-constraints">/model-constraints</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns model-constraint</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns model-constraint</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to the main definition of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to one version of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-element-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-constraint-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-type
+ </td>
+ <td>
+ <p>Type of the model, e.g., service, resource, widget, etc.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-name
+ </td>
+ <td>
+ <p>Name of the model, which can change from version to version.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version
+ </td>
+ <td>
+ <p>Version</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ distribution-status
+ </td>
+ <td>
+ <p>Distribution Status</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/model-constraint">/model-constraint</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing model-constraint</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing model-constraint</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>model-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/model-constraint">/model-constraint</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to the main definition of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to one version of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-element-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-constraint-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing model-constraint</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing model-constraint</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>model-constraint object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/model-constraint">/model-constraint</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to the main definition of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to one version of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-element-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-constraint-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing model-constraint</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing model-constraint</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to the main definition of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to one version of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-element-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-constraint-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns constrained-element-sets</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns constrained-element-sets</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to the main definition of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to one version of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-element-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-constraint-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-type
+ </td>
+ <td>
+ <p>Type of the model, e.g., service, resource, widget, etc.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-name
+ </td>
+ <td>
+ <p>Name of the model, which can change from version to version.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version
+ </td>
+ <td>
+ <p>Version</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ distribution-status
+ </td>
+ <td>
+ <p>Distribution Status</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/constrained-element-sets">/constrained-element-sets</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns constrained-element-set</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns constrained-element-set</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to the main definition of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to one version of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-element-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-constraint-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ constrained-element-set-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-type
+ </td>
+ <td>
+ <p>Type of the model, e.g., service, resource, widget, etc.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-name
+ </td>
+ <td>
+ <p>Name of the model, which can change from version to version.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version
+ </td>
+ <td>
+ <p>Version</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ distribution-status
+ </td>
+ <td>
+ <p>Distribution Status</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/constrained-element-set">/constrained-element-set</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing constrained-element-set</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing constrained-element-set</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>constrained-element-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/constrained-element-set">/constrained-element-set</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to the main definition of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to one version of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-element-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-constraint-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ constrained-element-set-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing constrained-element-set</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing constrained-element-set</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>constrained-element-set object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/constrained-element-set">/constrained-element-set</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to the main definition of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to one version of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-element-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-constraint-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ constrained-element-set-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing constrained-element-set</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing constrained-element-set</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to the main definition of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to one version of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-element-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-constraint-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ constrained-element-set-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns element-choice-sets</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns element-choice-sets</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to the main definition of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to one version of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-element-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-constraint-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ constrained-element-set-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-type
+ </td>
+ <td>
+ <p>Type of the model, e.g., service, resource, widget, etc.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-name
+ </td>
+ <td>
+ <p>Name of the model, which can change from version to version.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version
+ </td>
+ <td>
+ <p>Version</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ distribution-status
+ </td>
+ <td>
+ <p>Distribution Status</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/element-choice-sets">/element-choice-sets</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns element-choice-set</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns element-choice-set</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to the main definition of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to one version of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-element-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-constraint-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ constrained-element-set-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ element-choice-set-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-type
+ </td>
+ <td>
+ <p>Type of the model, e.g., service, resource, widget, etc.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-name
+ </td>
+ <td>
+ <p>Name of the model, which can change from version to version.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version
+ </td>
+ <td>
+ <p>Version</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ distribution-status
+ </td>
+ <td>
+ <p>Distribution Status</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/element-choice-set">/element-choice-set</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing element-choice-set</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing element-choice-set</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>element-choice-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/element-choice-set">/element-choice-set</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to the main definition of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to one version of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-element-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-constraint-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ constrained-element-set-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ element-choice-set-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing element-choice-set</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing element-choice-set</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>element-choice-set object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/element-choice-set">/element-choice-set</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to the main definition of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to one version of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-element-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-constraint-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ constrained-element-set-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ element-choice-set-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing element-choice-set</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing element-choice-set</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to the main definition of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to one version of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-element-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-constraint-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ constrained-element-set-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ element-choice-set-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to the main definition of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to one version of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-element-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-constraint-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ constrained-element-set-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ element-choice-set-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to the main definition of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to one version of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-element-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-constraint-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ constrained-element-set-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ element-choice-set-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to the main definition of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to one version of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-element-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-constraint-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ constrained-element-set-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to the main definition of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to one version of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-element-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-constraint-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ constrained-element-set-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to the main definition of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to one version of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-element-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to the main definition of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to one version of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-element-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-models-model--model-invariant-id--model-vers-model-ver--model-version-id--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVer.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to the main definition of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to one version of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-models-model--model-invariant-id--model-vers-model-ver--model-version-id--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to the main definition of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ model-version-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to one version of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-models-model--model-invariant-id--relationship-list-relationship-"></span>
+ <div id="operation--service-design-and-creation-models-model--model-invariant-id--relationship-list-relationship-put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModel.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to the main definition of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-models-model--model-invariant-id--relationship-list-relationship-"></span>
+ <div id="operation--service-design-and-creation-models-model--model-invariant-id--relationship-list-relationship-delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ model-invariant-id
+ </td>
+ <td>
+ <p>Unique identifier corresponding to the main definition of a model in ASDC</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-named-queries-"></span>
+ <div id="operation--service-design-and-creation-named-queries-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns named-queries</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/service-design-and-creation/named-queries</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns named-queries</p>
+
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/named-queries">/named-queries</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-named-queries-named-query--named-query-uuid--"></span>
+ <div id="operation--service-design-and-creation-named-queries-named-query--named-query-uuid--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns named-query</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/service-design-and-creation/named-queries/named-query/{named-query-uuid}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns named-query</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ named-query-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ named-query-name
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/named-query">/named-query</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-named-queries-named-query--named-query-uuid--"></span>
+ <div id="operation--service-design-and-creation-named-queries-named-query--named-query-uuid--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing named-query</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/service-design-and-creation/named-queries/named-query/{named-query-uuid}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing named-query</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>named-query object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQuery.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/named-query">/named-query</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ named-query-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-named-queries-named-query--named-query-uuid--"></span>
+ <div id="operation--service-design-and-creation-named-queries-named-query--named-query-uuid--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing named-query</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/service-design-and-creation/named-queries/named-query/{named-query-uuid}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing named-query</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>named-query object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/named-query">/named-query</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ named-query-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-named-queries-named-query--named-query-uuid--"></span>
+ <div id="operation--service-design-and-creation-named-queries-named-query--named-query-uuid--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing named-query</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/service-design-and-creation/named-queries/named-query/{named-query-uuid}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing named-query</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ named-query-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-named-queries-named-query--named-query-uuid--named-query-elements-"></span>
+ <div id="operation--service-design-and-creation-named-queries-named-query--named-query-uuid--named-query-elements-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns named-query-elements</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns named-query-elements</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ named-query-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ named-query-name
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/named-query-elements">/named-query-elements</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-named-queries-named-query--named-query-uuid--named-query-elements-named-query-element--named-query-element-uuid--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns named-query-element</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns named-query-element</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ named-query-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ named-query-element-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ named-query-name
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/named-query-element">/named-query-element</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-named-queries-named-query--named-query-uuid--named-query-elements-named-query-element--named-query-element-uuid--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing named-query-element</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing named-query-element</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>named-query-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/named-query-element">/named-query-element</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ named-query-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ named-query-element-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-named-queries-named-query--named-query-uuid--named-query-elements-named-query-element--named-query-element-uuid--"></span>
+ <div id="operation--service-design-and-creation-named-queries-named-query--named-query-uuid--named-query-elements-named-query-element--named-query-element-uuid--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing named-query-element</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing named-query-element</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>named-query-element object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/named-query-element">/named-query-element</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ named-query-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ named-query-element-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-named-queries-named-query--named-query-uuid--named-query-elements-named-query-element--named-query-element-uuid--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing named-query-element</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing named-query-element</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ named-query-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ named-query-element-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-named-queries-named-query--named-query-uuid--named-query-elements-named-query-element--named-query-element-uuid--property-constraints-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns property-constraints</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns property-constraints</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ named-query-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ named-query-element-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ named-query-name
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/property-constraints">/property-constraints</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns property-constraint</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns property-constraint</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ named-query-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ named-query-element-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ property-constraint-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ named-query-name
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/property-constraint">/property-constraint</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing property-constraint</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing property-constraint</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>property-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/property-constraint">/property-constraint</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ named-query-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ named-query-element-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ property-constraint-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing property-constraint</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing property-constraint</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>property-constraint object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/property-constraint">/property-constraint</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ named-query-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ named-query-element-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ property-constraint-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing property-constraint</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing property-constraint</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ named-query-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ named-query-element-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ property-constraint-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-named-queries-named-query--named-query-uuid--named-query-elements-named-query-element--named-query-element-uuid--related-lookups-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns related-lookups</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns related-lookups</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ named-query-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ named-query-element-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ named-query-name
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/related-lookups">/related-lookups</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">returns related-lookup</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns related-lookup</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ named-query-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ named-query-element-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ related-lookup-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ named-query-name
+ </td>
+ <td>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/related-lookup">/related-lookup</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing related-lookup</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing related-lookup</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>related-lookup object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/related-lookup">/related-lookup</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ named-query-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ named-query-element-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ related-lookup-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing related-lookup</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing related-lookup</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>related-lookup object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/related-lookup">/related-lookup</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ named-query-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ named-query-element-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ related-lookup-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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--"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing related-lookup</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing related-lookup</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ named-query-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ named-query-element-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ related-lookup-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ named-query-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ named-query-element-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ related-lookup-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--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-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/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</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ named-query-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ named-query-element-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ related-lookup-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-named-queries-named-query--named-query-uuid--named-query-elements-named-query-element--named-query-element-uuid--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ named-query-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ named-query-element-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-named-queries-named-query--named-query-uuid--named-query-elements-named-query-element--named-query-element-uuid--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ named-query-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ named-query-element-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-named-queries-named-query--named-query-uuid--relationship-list-relationship-"></span>
+ <div id="operation--service-design-and-creation-named-queries-named-query--named-query-uuid--relationship-list-relationship-put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQuery.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ named-query-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-named-queries-named-query--named-query-uuid--relationship-list-relationship-"></span>
+ <div id="operation--service-design-and-creation-named-queries-named-query--named-query-uuid--relationship-list-relationship-delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ named-query-uuid
+ </td>
+ <td>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-service-capabilities-"></span>
+ <div id="operation--service-design-and-creation-service-capabilities-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns service-capabilities</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/service-design-and-creation/service-capabilities</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns service-capabilities</p>
+
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/service-capabilities">/service-capabilities</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-service-capabilities-service-capability--service-type---vnf-type--"></span>
+ <div id="operation--service-design-and-creation-service-capabilities-service-capability--service-type---vnf-type--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns service-capability</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns service-capability</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ service-type
+ </td>
+ <td>
+ <p>This gets defined by others to provide a unique ID for the service, we accept what is sent.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/service-capability">/service-capability</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-service-capabilities-service-capability--service-type---vnf-type--"></span>
+ <div id="operation--service-design-and-creation-service-capabilities-service-capability--service-type---vnf-type--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing service-capability</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing service-capability</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>service-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/service-capability">/service-capability</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ service-type
+ </td>
+ <td>
+ <p>This gets defined by others to provide a unique ID for the service, we accept what is sent.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-service-capabilities-service-capability--service-type---vnf-type--"></span>
+ <div id="operation--service-design-and-creation-service-capabilities-service-capability--service-type---vnf-type--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing service-capability</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing service-capability</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>service-capability object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/service-capability">/service-capability</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ service-type
+ </td>
+ <td>
+ <p>This gets defined by others to provide a unique ID for the service, we accept what is sent.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-service-capabilities-service-capability--service-type---vnf-type--"></span>
+ <div id="operation--service-design-and-creation-service-capabilities-service-capability--service-type---vnf-type--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing service-capability</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing service-capability</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ service-type
+ </td>
+ <td>
+ <p>This gets defined by others to provide a unique ID for the service, we accept what is sent.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-service-capabilities-service-capability--service-type---vnf-type--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ service-type
+ </td>
+ <td>
+ <p>This gets defined by others to provide a unique ID for the service, we accept what is sent.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-service-capabilities-service-capability--service-type---vnf-type--relationship-list-relationship-"></span>
+ <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">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ service-type
+ </td>
+ <td>
+ <p>This gets defined by others to provide a unique ID for the service, we accept what is sent.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ vnf-type
+ </td>
+ <td>
+ <p>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.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-services-"></span>
+ <div id="operation--service-design-and-creation-services-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns services</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/service-design-and-creation/services</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns services</p>
+
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/services">/services</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-services-service--service-id--"></span>
+ <div id="operation--service-design-and-creation-services-service--service-id--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns service</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/service-design-and-creation/services/service/{service-id}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns service</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>This gets defined by others to provide a unique ID for the service, we accept what is sent.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ service-description
+ </td>
+ <td>
+ <p>Description of the service</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/service">/service</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-services-service--service-id--"></span>
+ <div id="operation--service-design-and-creation-services-service--service-id--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing service</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/service-design-and-creation/services/service/{service-id}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing service</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationServicesService.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/service">/service</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>This gets defined by others to provide a unique ID for the service, we accept what is sent.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-services-service--service-id--"></span>
+ <div id="operation--service-design-and-creation-services-service--service-id--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing service</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/service-design-and-creation/services/service/{service-id}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing service</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>service object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/service">/service</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>This gets defined by others to provide a unique ID for the service, we accept what is sent.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-services-service--service-id--"></span>
+ <div id="operation--service-design-and-creation-services-service--service-id--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing service</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/service-design-and-creation/services/service/{service-id}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing service</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>This gets defined by others to provide a unique ID for the service, we accept what is sent.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-services-service--service-id--relationship-list-relationship-"></span>
+ <div id="operation--service-design-and-creation-services-service--service-id--relationship-list-relationship-put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/service-design-and-creation/services/service/{service-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationServicesService.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>This gets defined by others to provide a unique ID for the service, we accept what is sent.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-services-service--service-id--relationship-list-relationship-"></span>
+ <div id="operation--service-design-and-creation-services-service--service-id--relationship-list-relationship-delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/service-design-and-creation/services/service/{service-id}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ service-id
+ </td>
+ <td>
+ <p>This gets defined by others to provide a unique ID for the service, we accept what is sent.</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-vnf-images-"></span>
+ <div id="operation--service-design-and-creation-vnf-images-get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns vnf-images</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/service-design-and-creation/vnf-images</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns vnf-images</p>
+
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/vnf-images">/vnf-images</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-vnf-images-vnf-image--vnf-image-uuid--"></span>
+ <div id="operation--service-design-and-creation-vnf-images-vnf-image--vnf-image-uuid--get" class="swagger--panel-operation-get panel">
+ <div class="panel-heading">
+ <div class="operation-summary">returns vnf-image</div>
+ <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>returns vnf-image</p>
+
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-image-uuid
+ </td>
+ <td>
+ <p>Unique ID of this asset</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ application
+ </td>
+ <td>
+ <p>The application that the image instantiates.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ application-vendor
+ </td>
+ <td>
+ <p>The vendor of the application.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ application-version
+ </td>
+ <td>
+ <p>The version of the application.</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-200">
+ 200 OK
+
+ </dt>
+ <dd class="sw-response-200">
+ <div class="row">
+ <div class="col-md-12">
+ <p>successful operation</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ <div class="panel panel-definition">
+
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/getDefinitions/vnf-image">/vnf-image</a>
+ </div>
+ </div>
+ </div>
+
+ </div> </dd>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-vnf-images-vnf-image--vnf-image-uuid--"></span>
+ <div id="operation--service-design-and-creation-vnf-images-vnf-image--vnf-image-uuid--put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">create or update an existing vnf-image</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>create or update an existing vnf-image</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>vnf-image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationVnfImagesVnfImage.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/vnf-image">/vnf-image</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-image-uuid
+ </td>
+ <td>
+ <p>Unique ID of this asset</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-vnf-images-vnf-image--vnf-image-uuid--"></span>
+ <div id="operation--service-design-and-creation-vnf-images-vnf-image--vnf-image-uuid--patch" class="swagger--panel-operation-patch panel">
+ <div class="panel-heading">
+ <div class="operation-summary">update an existing vnf-image</div>
+ <h3 class="panel-title"><span class="operation-name">PATCH</span> <strong>/service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>update an existing vnf-image</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>vnf-image object that needs to be created or updated.</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/patchDefinitions/vnf-image">/vnf-image</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-image-uuid
+ </td>
+ <td>
+ <p>Unique ID of this asset</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-vnf-images-vnf-image--vnf-image-uuid--"></span>
+ <div id="operation--service-design-and-creation-vnf-images-vnf-image--vnf-image-uuid--delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing vnf-image</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing vnf-image</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-image-uuid
+ </td>
+ <td>
+ <p>Unique ID of this asset</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ resource-version
+ </td>
+ <td>
+ <p>resource-version for concurrency</p>
+ </td>
+ <td>query</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-vnf-images-vnf-image--vnf-image-uuid--relationship-list-relationship-"></span>
+ <div id="operation--service-design-and-creation-vnf-images-vnf-image--vnf-image-uuid--relationship-list-relationship-put" class="swagger--panel-operation-put panel">
+ <div class="panel-heading">
+ <div class="operation-summary">see node definition for valid relationships</div>
+ <h3 class="panel-title"><span class="operation-name">PUT</span> <strong>/service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>see node definition for valid relationships</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ <div class="row">
+ <div class="col-md-6">
+ <p><p>relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationVnfImagesVnfImage.json)</p>
+ </p>
+ </div>
+ <div class="col-md-6 sw-request-model">
+ <div class="panel panel-definition">
+ <div class="panel-body">
+ <a class="json-schema-ref" href="#/definitions/relationship">/relationship</a>
+ </div>
+ </div></div>
+ </div>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-image-uuid
+ </td>
+ <td>
+ <p>Unique ID of this asset</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+ <span id="path--service-design-and-creation-vnf-images-vnf-image--vnf-image-uuid--relationship-list-relationship-"></span>
+ <div id="operation--service-design-and-creation-vnf-images-vnf-image--vnf-image-uuid--relationship-list-relationship-delete" class="swagger--panel-operation-delete panel">
+ <div class="panel-heading">
+ <div class="operation-summary">delete an existing relationship</div>
+ <h3 class="panel-title"><span class="operation-name">DELETE</span> <strong>/service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship</strong></h3>
+ Tags:
+ <a href="#tag-ServiceDesignAndCreation">ServiceDesignAndCreation</a>
+ </div>
+ <div class="panel-body">
+ <section class="sw-operation-description">
+ <p>delete an existing relationship</p>
+
+ </section>
+ <section class="sw-request-body">
+
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+ </section>
+ <section class="sw-request-params">
+ <table class="table">
+ <thead>
+ <tr>
+ <th class="sw-param-name"></th>
+ <th class="sw-param-description"></th>
+ <th class="sw-param-type"></th>
+ <th class="sw-param-data-type"></th>
+ <th class="sw-param-annotation"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ vnf-image-uuid
+ </td>
+ <td>
+ <p>Unique ID of this asset</p>
+ </td>
+ <td>path</td>
+ <td>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+ </td>
+ <td>
+ <span class="json-property-required"></span>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+
+ <section class="sw-responses">
+ <p><span class="label label-default">application/json</span> <span class="label label-default">application/xml</span>
+ </p>
+
+ <dl>
+ <dt class="sw-response-default">
+ default
+
+ </dt>
+ <dd class="sw-response-default">
+ <div class="row">
+ <div class="col-md-12">
+ <p>Response codes found in <a href="https://wiki.onap.org/">response codes</a>.</p>
+
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-6 sw-response-model">
+ </div>
+
+ </div> </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+
+
+ <h2>Schema definitions</h2>
+
+ <div id="definition-aai-internal" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/aai-internal"></a>aai-internal:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="property-name">
+ <span class="json-property-name">property-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="property-value">
+ <span class="json-property-name">property-value:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-action" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/action"></a>action:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="action-type">
+ <span class="json-property-name">action-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="action-data">
+ <span class="json-property-name">action-data:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/action-data">action-data</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-action-data" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/action-data"></a>action-data:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="property-name">
+ <span class="json-property-name">property-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="property-value">
+ <span class="json-property-name">property-value:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-actions" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/actions"></a>actions:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>APIs that are more action related than REST (e.g., notify, update).</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="update">
+ <span class="json-property-name">update:</span>
+ <span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/update">update</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="notify">
+ <span class="json-property-name">notify:</span>
+ <span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/notify">notify</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-allotted-resource" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/allotted-resource"></a>allotted-resource:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Represents a slice or partial piece of a resource that gets separately allotted</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE)</li>
+<li>TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)</li>
+<li>TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)</li>
+<li>TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)</li>
+<li>TO l-interface( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY)</li>
+<li>TO network-policy( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)</li>
+<li>TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)</li>
+<li>TO vpn-binding( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY)</li>
+<li>TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)</li>
+<li>TO model-ver( allotted-resource org.onap.relationships.inventory.IsA model-ver, Many2One)</li>
+<li>FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)</li>
+<li>FROM configuration( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)</li>
+<li>FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)</li>
+<li>FROM allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE)</li>
+<li>ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="id">
+ <span class="json-property-name">id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Allotted Resource id UUID assigned to this instance.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="description">
+ <span class="json-property-name">description:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>The descriptive information assigned to this allotted resource instance</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="selflink">
+ <span class="json-property-name">selflink:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Link back to more information in the controller</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="model-invariant-id">
+ <span class="json-property-name">model-invariant-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>the ASDC model id for this resource or service model.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="model-version-id">
+ <span class="json-property-name">model-version-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>the ASDC model version for this resource or service model.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="persona-model-version">
+ <span class="json-property-name">persona-model-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>the ASDC model version for this resource or service model.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Concurrency value</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="orchestration-status">
+ <span class="json-property-name">orchestration-status:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Orchestration status</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="operational-status">
+ <span class="json-property-name">operational-status:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Indicator for whether the resource is considered operational</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="type">
+ <span class="json-property-name">type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Generic description of the type of allotted resource.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="role">
+ <span class="json-property-name">role:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>role in the network that this resource will be providing.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="tunnel-xconnects">
+ <span class="json-property-name">tunnel-xconnects:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/tunnel-xconnect">tunnel-xconnect</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-allotted-resources" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/allotted-resources"></a>allotted-resources:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>This object is used to store slices of services being offered</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="allotted-resource">
+ <span class="json-property-name">allotted-resource:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/allotted-resource">allotted-resource</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-availability-zone" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/availability-zone"></a>availability-zone:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Availability zone, a collection of compute hosts/pservers</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)</li>
+<li>TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)</li>
+<li>TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)</li>
+<li>FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)</li>
+<li>FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)</li>
+<li>FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)</li>
+<li>FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)</li>
+<li>FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)</li>
+<li>AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="availability-zone-name">
+ <span class="json-property-name">availability-zone-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Name of the availability zone. Unique across a cloud region</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="hypervisor-type">
+ <span class="json-property-name">hypervisor-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Type of hypervisor. Source of truth should define valid values.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="operational-status">
+ <span class="json-property-name">operational-status:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>State that indicates whether the availability zone should be used, etc. Source of truth should define valid values.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-availability-zones" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/availability-zones"></a>availability-zones:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Collection of availability zones</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="availability-zone">
+ <span class="json-property-name">availability-zone:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/availability-zone">availability-zone</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-az-and-dvs-switches" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/az-and-dvs-switches"></a>az-and-dvs-switches:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="dvs-switches">
+ <span class="json-property-name">dvs-switches:</span>
+ <span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/dvs-switches">dvs-switches</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="availability-zone">
+ <span class="json-property-name">availability-zone:</span>
+ <span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/availability-zone">availability-zone</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-business" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/business"></a>business:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Namespace for business related constructs</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="connectors">
+ <span class="json-property-name">connectors:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/connector">connector</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="customers">
+ <span class="json-property-name">customers:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/customer">customer</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="lines-of-business">
+ <span class="json-property-name">lines-of-business:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/line-of-business">line-of-business</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="owning-entities">
+ <span class="json-property-name">owning-entities:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/owning-entity">owning-entity</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="platforms">
+ <span class="json-property-name">platforms:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/platform">platform</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="projects">
+ <span class="json-property-name">projects:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/project">project</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-class-of-service" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/class-of-service"></a>class-of-service:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="cos">
+ <span class="json-property-name">cos:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>unique identifier of probe</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="probe-id">
+ <span class="json-property-name">probe-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>identifier of probe</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="probe-type">
+ <span class="json-property-name">probe-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>type of probe</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-classes-of-service" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/classes-of-service"></a>classes-of-service:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>class-of-service of probe</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="class-of-service">
+ <span class="json-property-name">class-of-service:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/class-of-service">class-of-service</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-cloud-infrastructure" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/cloud-infrastructure"></a>cloud-infrastructure:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Namespace for cloud infrastructure.</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="complexes">
+ <span class="json-property-name">complexes:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/complex">complex</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="cloud-regions">
+ <span class="json-property-name">cloud-regions:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/cloud-region">cloud-region</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="network-profiles">
+ <span class="json-property-name">network-profiles:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/network-profile">network-profile</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="pservers">
+ <span class="json-property-name">pservers:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/pserver">pserver</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="virtual-data-centers">
+ <span class="json-property-name">virtual-data-centers:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/virtual-data-center">virtual-data-center</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="operational-environments">
+ <span class="json-property-name">operational-environments:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/operational-environment">operational-environment</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-cloud-region" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/cloud-region"></a>cloud-region:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>cloud-region designates an installation of a cloud cluster or region or instantiation.</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many)</li>
+<li>TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)</li>
+<li>TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)</li>
+<li>TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)</li>
+<li>FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)</li>
+<li>FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)</li>
+<li>FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)</li>
+<li>FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)</li>
+<li>FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)</li>
+<li>FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)</li>
+<li>FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)</li>
+<li>FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)</li>
+<li>FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)</li>
+<li>FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)</li>
+<li>FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)</li>
+<li>FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)</li>
+<li>FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)</li>
+<li>CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP</li>
+<li>CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE</li>
+<li>CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="cloud-owner">
+ <span class="json-property-name">cloud-owner:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="cloud-region-id">
+ <span class="json-property-name">cloud-region-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Identifier used by the vendor for the region. Second part of composite key</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="cloud-type">
+ <span class="json-property-name">cloud-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Type of the cloud (e.g., openstack)</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="owner-defined-type">
+ <span class="json-property-name">owner-defined-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Cloud-owner defined type indicator (e.g., dcp, lcp)</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="cloud-region-version">
+ <span class="json-property-name">cloud-region-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="identity-url">
+ <span class="json-property-name">identity-url:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>URL of the keystone identity service</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="cloud-zone">
+ <span class="json-property-name">cloud-zone:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="complex-name">
+ <span class="json-property-name">complex-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="sriov-automation">
+ <span class="json-property-name">sriov-automation:</span>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="cloud-extra-info">
+ <span class="json-property-name">cloud-extra-info:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="cloud-epa-caps">
+ <span class="json-property-name">cloud-epa-caps:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>MultiVIM will discover and expose EPA capabilities.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="volume-groups">
+ <span class="json-property-name">volume-groups:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/volume-group">volume-group</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="tenants">
+ <span class="json-property-name">tenants:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/tenant">tenant</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="flavors">
+ <span class="json-property-name">flavors:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/flavor">flavor</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="group-assignments">
+ <span class="json-property-name">group-assignments:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/group-assignment">group-assignment</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="snapshots">
+ <span class="json-property-name">snapshots:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/snapshot">snapshot</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="images">
+ <span class="json-property-name">images:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/image">image</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="dvs-switches">
+ <span class="json-property-name">dvs-switches:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/dvs-switch">dvs-switch</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="oam-networks">
+ <span class="json-property-name">oam-networks:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/oam-network">oam-network</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="availability-zones">
+ <span class="json-property-name">availability-zones:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/availability-zone">availability-zone</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="vip-ipv4-address-list">
+ <span class="json-property-name">vip-ipv4-address-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/vip-ipv4-address-list">vip-ipv4-address-list</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="vip-ipv6-address-list">
+ <span class="json-property-name">vip-ipv6-address-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/vip-ipv6-address-list">vip-ipv6-address-list</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-cloud-regions" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/cloud-regions"></a>cloud-regions:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="cloud-region">
+ <span class="json-property-name">cloud-region:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/cloud-region">cloud-region</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-complex" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/complex"></a>complex:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Collection of physical locations that can house cloud-regions.</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)</li>
+<li>FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)</li>
+<li>FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)</li>
+<li>FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)</li>
+<li>FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)</li>
+<li>FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)</li>
+<li>FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)</li>
+<li>FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)</li>
+<li>FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)</li>
+<li>FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)</li>
+<li>FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)</li>
+<li>FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)</li>
+<li>COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE</li>
+<li>COMPLEX is DELETED when these are DELETED CTAG-POOL</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="physical-location-id">
+ <span class="json-property-name">physical-location-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Unique identifier for physical location, e.g., CLLI</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="data-center-code">
+ <span class="json-property-name">data-center-code:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Data center code which can be an alternate way to identify a complex</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="complex-name">
+ <span class="json-property-name">complex-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Gamma complex name for LCP instance.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="identity-url">
+ <span class="json-property-name">identity-url:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>URL of the keystone identity service</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="physical-location-type">
+ <span class="json-property-name">physical-location-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Type, e.g., central office, data center.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="street1">
+ <span class="json-property-name">street1:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="street2">
+ <span class="json-property-name">street2:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="city">
+ <span class="json-property-name">city:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="state">
+ <span class="json-property-name">state:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="postal-code">
+ <span class="json-property-name">postal-code:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="country">
+ <span class="json-property-name">country:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="region">
+ <span class="json-property-name">region:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="latitude">
+ <span class="json-property-name">latitude:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="longitude">
+ <span class="json-property-name">longitude:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="elevation">
+ <span class="json-property-name">elevation:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="lata">
+ <span class="json-property-name">lata:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="ctag-pools">
+ <span class="json-property-name">ctag-pools:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/ctag-pool">ctag-pool</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-complexes" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/complexes"></a>complexes:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Collection of physical locations that can house cloud-regions.</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="complex">
+ <span class="json-property-name">complex:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/complex">complex</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-configuration" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/configuration"></a>configuration:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Port Mirror Configuration.</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)</li>
+<li>TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)</li>
+<li>TO l-interface( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY)</li>
+<li>TO pnf( configuration org.onap.relationships.inventory.AppliesTo pnf, ONE2MANY)</li>
+<li>FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)</li>
+<li>FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)</li>
+<li>FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)</li>
+<li>FROM forwarder( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)</li>
+<li>FROM forwarding-path( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)</li>
+<li>FROM evc( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)</li>
+<li>FROM forwarder-evc( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)</li>
+<li>CONFIGURATION is DELETED when these are DELETED METADATUM,EVC,FORWARDER-EVC</li>
+<li>CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="configuration-id">
+ <span class="json-property-name">configuration-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>UUID assigned to configuration.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="management-option">
+ <span class="json-property-name">management-option:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="configuration-name">
+ <span class="json-property-name">configuration-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Name of the configuration.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="configuration-type">
+ <span class="json-property-name">configuration-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>port-mirroring-configuration.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="configuration-sub-type">
+ <span class="json-property-name">configuration-sub-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>vprobe, pprobe.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="model-invariant-id">
+ <span class="json-property-name">model-invariant-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>the ASDC model id for this resource or service model.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="model-version-id">
+ <span class="json-property-name">model-version-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>the ASDC model version for this resource or service model.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="orchestration-status">
+ <span class="json-property-name">orchestration-status:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Orchestration status of the configuration.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="operational-status">
+ <span class="json-property-name">operational-status:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Indicator for whether the resource is considered operational.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="configuration-selflink">
+ <span class="json-property-name">configuration-selflink:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>URL to endpoint where AAI can get more details from SDN-GC.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="model-customization-id">
+ <span class="json-property-name">model-customization-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>id of the configuration used to customize the resource</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="tunnel-bandwidth">
+ <span class="json-property-name">tunnel-bandwidth:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>DHV Site Effective Bandwidth</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vendor-allowed-max-bandwidth">
+ <span class="json-property-name">vendor-allowed-max-bandwidth:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Velocloud Nominal Throughput - VNT</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="metadata">
+ <span class="json-property-name">metadata:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/metadatum">metadatum</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="forwarder-evcs">
+ <span class="json-property-name">forwarder-evcs:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/forwarder-evc">forwarder-evc</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="evcs">
+ <span class="json-property-name">evcs:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/evc">evc</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-configurations" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/configurations"></a>configurations:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Collection of configurations</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="configuration">
+ <span class="json-property-name">configuration:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/configuration">configuration</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-connector" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/connector"></a>connector:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Collection of resource instances used to connect a variety of disparate inventory widgets</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)</li>
+<li>FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)</li>
+<li>FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)</li>
+<li>CONNECTOR is DELETED when these are DELETED METADATUM</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="resource-instance-id">
+ <span class="json-property-name">resource-instance-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Unique id of resource instance.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="model-invariant-id">
+ <span class="json-property-name">model-invariant-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>the ASDC model id for this resource or service model.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="model-version-id">
+ <span class="json-property-name">model-version-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>the ASDC model version for this resource or service model.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="persona-model-version">
+ <span class="json-property-name">persona-model-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>the ASDC model version for this resource or service model.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="widget-model-id">
+ <span class="json-property-name">widget-model-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="widget-model-version">
+ <span class="json-property-name">widget-model-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="metadata">
+ <span class="json-property-name">metadata:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/metadatum">metadatum</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-connectors" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/connectors"></a>connectors:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Collection of resource instances used to connect a variety of disparate inventory widgets</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="connector">
+ <span class="json-property-name">connector:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/connector">connector</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-constrained-element-set" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/constrained-element-set"></a>constrained-element-set:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>This is how we would capture constraints defining allowed sets of elements.</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)</li>
+<li>TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)</li>
+<li>FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)</li>
+<li>CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="constrained-element-set-uuid">
+ <span class="json-property-name">constrained-element-set-uuid:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="constraint-type">
+ <span class="json-property-name">constraint-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="check-type">
+ <span class="json-property-name">check-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="element-choice-sets">
+ <span class="json-property-name">element-choice-sets:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/element-choice-set">element-choice-set</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-constrained-element-sets" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/constrained-element-sets"></a>constrained-element-sets:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="constrained-element-set">
+ <span class="json-property-name">constrained-element-set:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/constrained-element-set">constrained-element-set</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-ctag-assignment" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/ctag-assignment"></a>ctag-assignment:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)</li>
+<li>FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="vlan-id-inner">
+ <span class="json-property-name">vlan-id-inner:</span>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>id.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-ctag-assignments" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/ctag-assignments"></a>ctag-assignments:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="ctag-assignment">
+ <span class="json-property-name">ctag-assignment:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/ctag-assignment">ctag-assignment</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-ctag-pool" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/ctag-pool"></a>ctag-pool:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>A collection of C tags (vlan tags) grouped for a specific purpose.</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)</li>
+<li>TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)</li>
+<li>FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)</li>
+<li>FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="target-pe">
+ <span class="json-property-name">target-pe:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>The Target provider edge router</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="availability-zone-name">
+ <span class="json-property-name">availability-zone-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Name of the availability zone</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="ctag-pool-purpose">
+ <span class="json-property-name">ctag-pool-purpose:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Describes what the intended purpose of this pool is.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="ctag-values">
+ <span class="json-property-name">ctag-values:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Comma separated list of ctags</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-ctag-pools" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/ctag-pools"></a>ctag-pools:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="ctag-pool">
+ <span class="json-property-name">ctag-pool:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/ctag-pool">ctag-pool</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-customer" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/customer"></a>customer:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>customer identifiers to provide linkage back to BSS information.</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)</li>
+<li>CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="global-customer-id">
+ <span class="json-property-name">global-customer-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Global customer id used across ECOMP to uniquely identify customer.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="subscriber-name">
+ <span class="json-property-name">subscriber-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Subscriber name, an alternate way to retrieve a customer.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="subscriber-type">
+ <span class="json-property-name">subscriber-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Subscriber type, a way to provide VID with only the INFRA customers.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="service-subscriptions">
+ <span class="json-property-name">service-subscriptions:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/service-subscription">service-subscription</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-customers" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/customers"></a>customers:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Collection of customer identifiers to provide linkage back to BSS information.</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="customer">
+ <span class="json-property-name">customer:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/customer">customer</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-cvlan-tag-entry" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/cvlan-tag-entry"></a>cvlan-tag-entry:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="cvlan-tag">
+ <span class="json-property-name">cvlan-tag:</span>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>See mis-na-virtualization-platform.yang</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-cvlan-tags" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/cvlan-tags"></a>cvlan-tags:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="cvlan-tag-entry">
+ <span class="json-property-name">cvlan-tag-entry:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/cvlan-tag-entry">cvlan-tag-entry</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-dvs-switch" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/dvs-switch"></a>dvs-switch:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>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.</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)</li>
+<li>TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="switch-name">
+ <span class="json-property-name">switch-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>DVS switch name</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vcenter-url">
+ <span class="json-property-name">vcenter-url:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>URL used to reach the vcenter</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-dvs-switches" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/dvs-switches"></a>dvs-switches:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="dvs-switch">
+ <span class="json-property-name">dvs-switch:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/dvs-switch">dvs-switch</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-edge-prop-names" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/edge-prop-names"></a>edge-prop-names:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Internal map to define the properties of an edge and interpret the map EdgeRules</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="edgeLabel">
+ <span class="json-property-name">edgeLabel:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="direction">
+ <span class="json-property-name">direction:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="multiplicityRule">
+ <span class="json-property-name">multiplicityRule:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="contains-other-v">
+ <span class="json-property-name">contains-other-v:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="delete-other-v">
+ <span class="json-property-name">delete-other-v:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="SVC-INFRA">
+ <span class="json-property-name">SVC-INFRA:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="prevent-delete">
+ <span class="json-property-name">prevent-delete:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="aai-uuid">
+ <span class="json-property-name">aai-uuid:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-edge-tag-query-request" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/edge-tag-query-request"></a>edge-tag-query-request:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="edge-tag">
+ <span class="json-property-name">edge-tag:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="result-detail">
+ <span class="json-property-name">result-detail:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="start-node-type">
+ <span class="json-property-name">start-node-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="start-node-filter">
+ <span class="json-property-name">start-node-filter:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/start-node-filter">start-node-filter</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="include-node-filter">
+ <span class="json-property-name">include-node-filter:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/include-node-filter">include-node-filter</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="secondary-filter">
+ <span class="json-property-name">secondary-filter:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/secondary-filter">secondary-filter</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-edge-tag-query-result" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/edge-tag-query-result"></a>edge-tag-query-result:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="tagged-inventory-item-list">
+ <span class="json-property-name">tagged-inventory-item-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/tagged-inventory-item-list">tagged-inventory-item-list</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-element-choice-set" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/element-choice-set"></a>element-choice-set:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>This is how we would capture constraints defining allowed sets of elements.</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)</li>
+<li>FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)</li>
+<li>ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="element-choice-set-uuid">
+ <span class="json-property-name">element-choice-set-uuid:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="element-choice-set-name">
+ <span class="json-property-name">element-choice-set-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="cardinality">
+ <span class="json-property-name">cardinality:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="model-elements">
+ <span class="json-property-name">model-elements:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/model-element">model-element</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-element-choice-sets" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/element-choice-sets"></a>element-choice-sets:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="element-choice-set">
+ <span class="json-property-name">element-choice-set:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/element-choice-set">element-choice-set</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-entitlement" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/entitlement"></a>entitlement:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Metadata for entitlement group.</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)</li>
+<li>TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="group-uuid">
+ <span class="json-property-name">group-uuid:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Unique ID for the entitlement group the resource comes from, should be uuid.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-uuid">
+ <span class="json-property-name">resource-uuid:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Unique ID of an entitlement resource.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Concurrency value</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-entitlements" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/entitlements"></a>entitlements:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Entitlements, keyed by group-uuid and resource-uuid, related to license management</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="entitlement">
+ <span class="json-property-name">entitlement:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/entitlement">entitlement</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-esr-ems" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/esr-ems"></a>esr-ems:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Persist EMS address information used by EMS driver.</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)</li>
+<li>ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="ems-id">
+ <span class="json-property-name">ems-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Unique ID of EMS.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="esr-system-info-list">
+ <span class="json-property-name">esr-system-info-list:</span>
+ <span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/esr-system-info-list">esr-system-info-list</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship-list">relationship-list</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-esr-ems-list" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/esr-ems-list"></a>esr-ems-list:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="esr-ems">
+ <span class="json-property-name">esr-ems:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/esr-ems">esr-ems</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-esr-system-info" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/esr-system-info"></a>esr-system-info:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Persist common address information of external systems.</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)</li>
+<li>FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)</li>
+<li>FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)</li>
+<li>FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="esr-system-info-id">
+ <span class="json-property-name">esr-system-info-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Unique ID of esr system info.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="system-name">
+ <span class="json-property-name">system-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>name of external system.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="type">
+ <span class="json-property-name">type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>type of external systems.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vendor">
+ <span class="json-property-name">vendor:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>vendor of external systems.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="version">
+ <span class="json-property-name">version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>version of external systems.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="service-url">
+ <span class="json-property-name">service-url:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>url used to access external systems.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="user-name">
+ <span class="json-property-name">user-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>username used to access external systems.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="password">
+ <span class="json-property-name">password:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>password used to access external systems.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="system-type">
+ <span class="json-property-name">system-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="protocol">
+ <span class="json-property-name">protocol:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>protocol of third party SDNC, for example netconf/snmp.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="ssl-cacert">
+ <span class="json-property-name">ssl-cacert:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>ca file content if enabled ssl on auth-url.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="ssl-insecure">
+ <span class="json-property-name">ssl-insecure:</span>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Whether to verify VIM's certificate.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="ip-address">
+ <span class="json-property-name">ip-address:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>service IP of ftp server.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="port">
+ <span class="json-property-name">port:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>service port of ftp server.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="cloud-domain">
+ <span class="json-property-name">cloud-domain:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>domain info for authentication.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="default-tenant">
+ <span class="json-property-name">default-tenant:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>default tenant of VIM.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="passive">
+ <span class="json-property-name">passive:</span>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>ftp passive mode or not.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="remote-path">
+ <span class="json-property-name">remote-path:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>resource or performance data file path.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="system-status">
+ <span class="json-property-name">system-status:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>the status of external system.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship-list">relationship-list</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-esr-system-info-list" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/esr-system-info-list"></a>esr-system-info-list:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Collection of persistent block-level external system auth info.</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="esr-system-info">
+ <span class="json-property-name">esr-system-info:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/esr-system-info">esr-system-info</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-esr-thirdparty-sdnc" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/esr-thirdparty-sdnc"></a>esr-thirdparty-sdnc:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Persist SDNC address information used by ONAP SDNC.</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)</li>
+<li>TO pnf( esr-thirdparty-sdnc has pnf, One2Many)</li>
+<li>ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="thirdparty-sdnc-id">
+ <span class="json-property-name">thirdparty-sdnc-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Unique ID of SDNC.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="location">
+ <span class="json-property-name">location:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>used for DC type to indicate the location of SDNC, such as Core or Edge.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="product-name">
+ <span class="json-property-name">product-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>password used to access SDNC server.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="esr-system-info-list">
+ <span class="json-property-name">esr-system-info-list:</span>
+ <span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/esr-system-info-list">esr-system-info-list</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship-list">relationship-list</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-esr-thirdparty-sdnc-list" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/esr-thirdparty-sdnc-list"></a>esr-thirdparty-sdnc-list:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="esr-thirdparty-sdnc">
+ <span class="json-property-name">esr-thirdparty-sdnc:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/esr-thirdparty-sdnc">esr-thirdparty-sdnc</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-esr-vnfm" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/esr-vnfm"></a>esr-vnfm:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Persist VNFM address information used by VF-C.</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)</li>
+<li>ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="vnfm-id">
+ <span class="json-property-name">vnfm-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Unique ID of VNFM.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vim-id">
+ <span class="json-property-name">vim-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>indecate the VIM to deploy VNF.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="certificate-url">
+ <span class="json-property-name">certificate-url:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>certificate url of VNFM.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="esr-system-info-list">
+ <span class="json-property-name">esr-system-info-list:</span>
+ <span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/esr-system-info-list">esr-system-info-list</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship-list">relationship-list</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-esr-vnfm-list" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/esr-vnfm-list"></a>esr-vnfm-list:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="esr-vnfm">
+ <span class="json-property-name">esr-vnfm:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/esr-vnfm">esr-vnfm</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-evc" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/evc"></a>evc:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>evc object is an optional child object of the Configuration object.</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="evc-id">
+ <span class="json-property-name">evc-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Unique/key field for the evc object</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="forwarding-path-topology">
+ <span class="json-property-name">forwarding-path-topology:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Point-to-Point, Multi-Point</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="cir-value">
+ <span class="json-property-name">cir-value:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Commited Information Rate</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="cir-units">
+ <span class="json-property-name">cir-units:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>CIR units</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="connection-diversity-group-id">
+ <span class="json-property-name">connection-diversity-group-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Diversity Group ID</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="service-hours">
+ <span class="json-property-name">service-hours:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>formerly Performance Group</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="esp-evc-circuit-id">
+ <span class="json-property-name">esp-evc-circuit-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>EVC Circuit ID of ESP EVC</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="esp-evc-cir-value">
+ <span class="json-property-name">esp-evc-cir-value:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Committed Information Rate (For ESP)</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="esp-evc-cir-units">
+ <span class="json-property-name">esp-evc-cir-units:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>CIR units (For ESP)</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="esp-itu-code">
+ <span class="json-property-name">esp-itu-code:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Identifies ESP</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="collector-pop-clli">
+ <span class="json-property-name">collector-pop-clli:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Collector POP CLLI (from the hostname of the access pnf)</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="inter-connect-type-ingress">
+ <span class="json-property-name">inter-connect-type-ingress:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Interconnect type on ingress side of EVC.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="tagmode-access-ingress">
+ <span class="json-property-name">tagmode-access-ingress:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>tagode for collector side of EVC</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="tagmode-access-egress">
+ <span class="json-property-name">tagmode-access-egress:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>tagMode for network side of EVC</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-evcs" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/evcs"></a>evcs:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="evc">
+ <span class="json-property-name">evc:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/evc">evc</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-external-system" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/external-system"></a>external-system:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Namespace for external system.</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="esr-ems-list">
+ <span class="json-property-name">esr-ems-list:</span>
+ <span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/esr-ems-list">esr-ems-list</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="esr-vnfm-list">
+ <span class="json-property-name">esr-vnfm-list:</span>
+ <span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/esr-vnfm-list">esr-vnfm-list</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="esr-thirdparty-sdnc-list">
+ <span class="json-property-name">esr-thirdparty-sdnc-list:</span>
+ <span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/esr-thirdparty-sdnc-list">esr-thirdparty-sdnc-list</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-extra-properties" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/extra-properties"></a>extra-properties:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Extra properties for inventory item for response list</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="extra-property">
+ <span class="json-property-name">extra-property:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/extra-property">extra-property</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-extra-property" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/extra-property"></a>extra-property:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="property-name">
+ <span class="json-property-name">property-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="property-value">
+ <span class="json-property-name">property-value:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-flavor" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/flavor"></a>flavor:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Openstack flavor.</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)</li>
+<li>FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)</li>
+<li>FLAVOR cannot be deleted if linked to VSERVER</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="flavor-id">
+ <span class="json-property-name">flavor-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Flavor id, expected to be unique across cloud-region.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="flavor-name">
+ <span class="json-property-name">flavor-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Flavor name</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="flavor-vcpus">
+ <span class="json-property-name">flavor-vcpus:</span>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Number of CPUs</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="flavor-ram">
+ <span class="json-property-name">flavor-ram:</span>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Amount of memory</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="flavor-disk">
+ <span class="json-property-name">flavor-disk:</span>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Disk space</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="flavor-ephemeral">
+ <span class="json-property-name">flavor-ephemeral:</span>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Amount of ephemeral disk space</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="flavor-swap">
+ <span class="json-property-name">flavor-swap:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>amount of swap space allocation</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="flavor-is-public">
+ <span class="json-property-name">flavor-is-public:</span>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>whether flavor is available to all users or private to the tenant it was created in.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="flavor-selflink">
+ <span class="json-property-name">flavor-selflink:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>URL to endpoint where AAI can get more details</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="flavor-disabled">
+ <span class="json-property-name">flavor-disabled:</span>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Boolean as to whether this flavor is no longer enabled</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-flavors" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/flavors"></a>flavors:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Collection of openstack flavors.</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="flavor">
+ <span class="json-property-name">flavor:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/flavor">flavor</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-forwarder" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/forwarder"></a>forwarder:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Entity describing a sequenced segment of forwarding path</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)</li>
+<li>TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)</li>
+<li>TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)</li>
+<li>TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)</li>
+<li>TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)</li>
+<li>FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="sequence">
+ <span class="json-property-name">sequence:</span>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Unique ID of this segmentation</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="forwarder-role">
+ <span class="json-property-name">forwarder-role:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>ingress, intermediate, egress</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-forwarder-evc" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/forwarder-evc"></a>forwarder-evc:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>forwarder object is an optional child object of the Configuration object.</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="forwarder-evc-id">
+ <span class="json-property-name">forwarder-evc-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Key for forwarder-evc object</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="circuit-id">
+ <span class="json-property-name">circuit-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="ivlan">
+ <span class="json-property-name">ivlan:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Internal VLAN.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="svlan">
+ <span class="json-property-name">svlan:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>SVLAN value for ingress of egress forwarder.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="cvlan">
+ <span class="json-property-name">cvlan:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>CVLAN value for ingress of egress forwarder.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-forwarder-evcs" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/forwarder-evcs"></a>forwarder-evcs:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="forwarder-evc">
+ <span class="json-property-name">forwarder-evc:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/forwarder-evc">forwarder-evc</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-forwarders" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/forwarders"></a>forwarders:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="forwarder">
+ <span class="json-property-name">forwarder:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/forwarder">forwarder</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-forwarding-path" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/forwarding-path"></a>forwarding-path:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Entity that describes the sequenced forwarding path between interfaces of services or resources</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)</li>
+<li>TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)</li>
+<li>FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)</li>
+<li>FORWARDING-PATH is DELETED when these are DELETED FORWARDER</li>
+<li>FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="forwarding-path-id">
+ <span class="json-property-name">forwarding-path-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Unique ID of this FP</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="forwarding-path-name">
+ <span class="json-property-name">forwarding-path-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Name of the FP</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="selflink">
+ <span class="json-property-name">selflink:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>the self link for this FP</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="forwarders">
+ <span class="json-property-name">forwarders:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/forwarder">forwarder</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-forwarding-paths" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/forwarding-paths"></a>forwarding-paths:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="forwarding-path">
+ <span class="json-property-name">forwarding-path:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/forwarding-path">forwarding-path</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-generic-vnf" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/generic-vnf"></a>generic-vnf:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>General purpose VNF</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)</li>
+<li>TO complex( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)</li>
+<li>TO configuration( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)</li>
+<li>TO ctag-pool( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)</li>
+<li>TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)</li>
+<li>TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)</li>
+<li>TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)</li>
+<li>TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY)</li>
+<li>TO pnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY)</li>
+<li>TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)</li>
+<li>TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)</li>
+<li>TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)</li>
+<li>TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)</li>
+<li>TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)</li>
+<li>TO model-ver( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One)</li>
+<li>FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)</li>
+<li>FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)</li>
+<li>FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)</li>
+<li>FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)</li>
+<li>FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)</li>
+<li>FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)</li>
+<li>FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)</li>
+<li>FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)</li>
+<li>FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)</li>
+<li>FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)</li>
+<li>FROM line-of-business( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)</li>
+<li>FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)</li>
+<li>FROM platform( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)</li>
+<li>GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE</li>
+<li>GENERIC-VNF deletion means associated objects of these types are also DELETED:CONFIGURATION</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="vnf-id">
+ <span class="json-property-name">vnf-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vnf-instance-id">
+ <span class="json-property-name">vnf-instance-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>vnf instance id.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vnf-name">
+ <span class="json-property-name">vnf-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Name of VNF.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vnf-name2">
+ <span class="json-property-name">vnf-name2:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Alternate name of VNF.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vnf-type">
+ <span class="json-property-name">vnf-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>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.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="service-id">
+ <span class="json-property-name">service-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="regional-resource-zone">
+ <span class="json-property-name">regional-resource-zone:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Regional way of organizing pservers, source of truth should define values</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="prov-status">
+ <span class="json-property-name">prov-status:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="operational-status">
+ <span class="json-property-name">operational-status:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="license-key">
+ <span class="json-property-name">license-key:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>OBSOLETE - do not use</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="equipment-role">
+ <span class="json-property-name">equipment-role:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Client should send valid enumerated value</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="orchestration-status">
+ <span class="json-property-name">orchestration-status:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Orchestration status of this VNF, used by MSO.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vnf-package-name">
+ <span class="json-property-name">vnf-package-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vnf-discriptor-name">
+ <span class="json-property-name">vnf-discriptor-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>vnf discriptor name</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="job-id">
+ <span class="json-property-name">job-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>job id corresponding to vnf</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="heat-stack-id">
+ <span class="json-property-name">heat-stack-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="mso-catalog-key">
+ <span class="json-property-name">mso-catalog-key:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Corresponds to the SDN-C catalog id used to configure this VCE</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="management-option">
+ <span class="json-property-name">management-option:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>identifier of managed by ATT or customer</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="ipv4-oam-address">
+ <span class="json-property-name">ipv4-oam-address:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="ipv4-loopback0-address">
+ <span class="json-property-name">ipv4-loopback0-address:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>v4 Loopback0 address</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="nm-lan-v6-address">
+ <span class="json-property-name">nm-lan-v6-address:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>v6 Loopback address</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="management-v6-address">
+ <span class="json-property-name">management-v6-address:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>v6 management address</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vcpu">
+ <span class="json-property-name">vcpu:</span>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vcpu-units">
+ <span class="json-property-name">vcpu-units:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vmemory">
+ <span class="json-property-name">vmemory:</span>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vmemory-units">
+ <span class="json-property-name">vmemory-units:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vdisk">
+ <span class="json-property-name">vdisk:</span>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vdisk-units">
+ <span class="json-property-name">vdisk-units:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="nshd">
+ <span class="json-property-name">nshd:</span>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>number of associated SHD in vnf.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="nvm">
+ <span class="json-property-name">nvm:</span>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>number of vms in vnf.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="nnet">
+ <span class="json-property-name">nnet:</span>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>number of network in vnf.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="in-maint">
+ <span class="json-property-name">in-maint:</span>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="is-closed-loop-disabled">
+ <span class="json-property-name">is-closed-loop-disabled:</span>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="summary-status">
+ <span class="json-property-name">summary-status:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="encrypted-access-flag">
+ <span class="json-property-name">encrypted-access-flag:</span>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>indicates whether generic-vnf access uses SSH</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="entitlement-assignment-group-uuid">
+ <span class="json-property-name">entitlement-assignment-group-uuid:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>UUID of the Entitlement group used for licensing VNFs, OBSOLETE - See child relationships.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="entitlement-resource-uuid">
+ <span class="json-property-name">entitlement-resource-uuid:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>UUID of the specific entitlement resource. OBSOLETE - See child relationships.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="license-assignment-group-uuid">
+ <span class="json-property-name">license-assignment-group-uuid:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>UUID of the license assignment group. OBSOLETE - See child relationships.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="license-key-uuid">
+ <span class="json-property-name">license-key-uuid:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>UUID of the actual license resource. OBSOLETE - See child relationships.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="model-invariant-id">
+ <span class="json-property-name">model-invariant-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>the ASDC model id for this resource or service model.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="model-version-id">
+ <span class="json-property-name">model-version-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>the ASDC model version for this resource or service model.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="persona-model-version">
+ <span class="json-property-name">persona-model-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>the ASDC model version for this resource or service model.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="model-customization-id">
+ <span class="json-property-name">model-customization-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>captures the id of all the configuration used to customize the resource for the service.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="widget-model-id">
+ <span class="json-property-name">widget-model-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="widget-model-version">
+ <span class="json-property-name">widget-model-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="as-number">
+ <span class="json-property-name">as-number:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>as-number of the VNF</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="regional-resource-subzone">
+ <span class="json-property-name">regional-resource-subzone:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>represents sub zone of the rr plane</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="nf-type">
+ <span class="json-property-name">nf-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Generic description of the type of NF</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="nf-function">
+ <span class="json-property-name">nf-function:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>English description of Network function that the specific VNF deployment is providing</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="nf-role">
+ <span class="json-property-name">nf-role:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>role in the network that this model will be providing</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="nf-naming-code">
+ <span class="json-property-name">nf-naming-code:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>string assigned to this model used for naming purposes</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="selflink">
+ <span class="json-property-name">selflink:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Path to the controller object.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="ipv4-oam-gateway-address">
+ <span class="json-property-name">ipv4-oam-gateway-address:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Gateway address</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="ipv4-oam-gateway-address-prefix-length">
+ <span class="json-property-name">ipv4-oam-gateway-address-prefix-length:</span>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Prefix length for oam-address</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vlan-id-outer">
+ <span class="json-property-name">vlan-id-outer:</span>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Temporary location for S-TAG to get to VCE</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="nm-profile-name">
+ <span class="json-property-name">nm-profile-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Network Management profile of this VNF</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="l-interfaces">
+ <span class="json-property-name">l-interfaces:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/l-interface">l-interface</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="lag-interfaces">
+ <span class="json-property-name">lag-interfaces:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/lag-interface">lag-interface</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="vf-modules">
+ <span class="json-property-name">vf-modules:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/vf-module">vf-module</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="licenses">
+ <span class="json-property-name">licenses:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/license">license</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="entitlements">
+ <span class="json-property-name">entitlements:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/entitlement">entitlement</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-generic-vnfs" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/generic-vnfs"></a>generic-vnfs:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Collection of VNFs</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="generic-vnf">
+ <span class="json-property-name">generic-vnf:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/generic-vnf">generic-vnf</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-group-assignment" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/group-assignment"></a>group-assignment:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Openstack group-assignment used to store exclusivity groups (EG).</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)</li>
+<li>FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)</li>
+<li>FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="group-id">
+ <span class="json-property-name">group-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Group id, expected to be unique across cloud-region.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="group-type">
+ <span class="json-property-name">group-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Group type - the type of group this instance refers to</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="group-name">
+ <span class="json-property-name">group-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Group name - name assigned to the group</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="group-description">
+ <span class="json-property-name">group-description:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Group description - description of the group</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-group-assignments" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/group-assignments"></a>group-assignments:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Collection of openstack group assignments</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="group-assignment">
+ <span class="json-property-name">group-assignment:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/group-assignment">group-assignment</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-host-route" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/host-route"></a>host-route:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="host-route-id">
+ <span class="json-property-name">host-route-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>host-route id</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="route-prefix">
+ <span class="json-property-name">route-prefix:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>subnet prefix</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="next-hop">
+ <span class="json-property-name">next-hop:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Could be ip-address, hostname, or service-instance</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="next-hop-type">
+ <span class="json-property-name">next-hop-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Should be ip-address, hostname, or service-instance to match next-hop</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-host-routes" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/host-routes"></a>host-routes:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="host-route">
+ <span class="json-property-name">host-route:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/host-route">host-route</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-image" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/image"></a>image:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Openstack image.</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)</li>
+<li>FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)</li>
+<li>FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)</li>
+<li>IMAGE cannot be deleted if linked to VSERVER</li>
+<li>IMAGE is DELETED when these are DELETED METADATUM</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="image-id">
+ <span class="json-property-name">image-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Image id, expected to be unique across cloud region</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="image-name">
+ <span class="json-property-name">image-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Image name</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="image-architecture">
+ <span class="json-property-name">image-architecture:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Operating system architecture.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="image-os-distro">
+ <span class="json-property-name">image-os-distro:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>The common name of the operating system distribution in lowercase</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="image-os-version">
+ <span class="json-property-name">image-os-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>The operating system version as specified by the distributor.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="application">
+ <span class="json-property-name">application:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>The application that the image instantiates.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="application-vendor">
+ <span class="json-property-name">application-vendor:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>The vendor of the application.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="application-version">
+ <span class="json-property-name">application-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>The version of the application.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="image-selflink">
+ <span class="json-property-name">image-selflink:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>URL to endpoint where AAI can get more details</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="metadata">
+ <span class="json-property-name">metadata:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/metadatum">metadatum</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-images" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/images"></a>images:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Collectio of Openstack images.</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="image">
+ <span class="json-property-name">image:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/image">image</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-include-node-filter" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/include-node-filter"></a>include-node-filter:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="include-node-type">
+ <span class="json-property-name">include-node-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-instance-filter" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/instance-filter"></a>instance-filter:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>InstanceFilter for performing a named-query or model query</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-instance-filters" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/instance-filters"></a>instance-filters:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>InstanceFilters for performing a named-query or model query</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="instance-filter">
+ <span class="json-property-name">instance-filter:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/instance-filter">instance-filter</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-instance-group" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/instance-group"></a>instance-group:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>General mechanism for grouping instances</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)</li>
+<li>FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)</li>
+<li>FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)</li>
+<li>FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)</li>
+<li>FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)</li>
+<li>FROM l3-network( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)</li>
+<li>FROM l-interface( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)</li>
+<li>FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)</li>
+<li>FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)</li>
+<li>FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)</li>
+<li>FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)</li>
+<li>FROM vnfc( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="instance-group-role">
+ <span class="json-property-name">instance-group-role:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>role of the instance group.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="model-invariant-id">
+ <span class="json-property-name">model-invariant-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>ASDC model id for this resource or service model.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="model-version-id">
+ <span class="json-property-name">model-version-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>ASDC model version uid for this resource model.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="id">
+ <span class="json-property-name">id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Instance Group ID, UUID assigned to this instance.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="description">
+ <span class="json-property-name">description:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Descriptive text to help identify the usage of this instance-group</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="type">
+ <span class="json-property-name">type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Only valid value today is lower case ha for high availability</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="sub-type">
+ <span class="json-property-name">sub-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Concurrency value</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-instance-groups" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/instance-groups"></a>instance-groups:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Collection of openstack route table references</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="instance-group">
+ <span class="json-property-name">instance-group:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/instance-group">instance-group</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-inventory" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/inventory"></a>inventory:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="search">
+ <span class="json-property-name">search:</span>
+ <span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/search">search</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="actions">
+ <span class="json-property-name">actions:</span>
+ <span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/actions">actions</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="cloud-infrastructure">
+ <span class="json-property-name">cloud-infrastructure:</span>
+ <span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/cloud-infrastructure">cloud-infrastructure</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="external-system">
+ <span class="json-property-name">external-system:</span>
+ <span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/external-system">external-system</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="business">
+ <span class="json-property-name">business:</span>
+ <span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/business">business</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="service-design-and-creation">
+ <span class="json-property-name">service-design-and-creation:</span>
+ <span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/service-design-and-creation">service-design-and-creation</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="network">
+ <span class="json-property-name">network:</span>
+ <span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/network">network</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="aai-internal">
+ <span class="json-property-name">aai-internal:</span>
+ <span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/aai-internal">aai-internal</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="nodes">
+ <span class="json-property-name">nodes:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/aai-internal">aai-internal</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-inventory-item" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/inventory-item"></a>inventory-item:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="inventory-item-type">
+ <span class="json-property-name">inventory-item-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="inventory-item-link">
+ <span class="json-property-name">inventory-item-link:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="inventory-item-data">
+ <span class="json-property-name">inventory-item-data:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/inventory-item-data">inventory-item-data</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="tagged-inventory-item-list">
+ <span class="json-property-name">tagged-inventory-item-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/tagged-inventory-item-list">tagged-inventory-item-list</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-inventory-item-data" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/inventory-item-data"></a>inventory-item-data:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="property-name">
+ <span class="json-property-name">property-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="property-value">
+ <span class="json-property-name">property-value:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-inventory-response-item" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/inventory-response-item"></a>inventory-response-item:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Inventory item for response list</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="model-name">
+ <span class="json-property-name">model-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="extra-properties">
+ <span class="json-property-name">extra-properties:</span>
+ <span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/extra-properties">extra-properties</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="inventory-response-items">
+ <span class="json-property-name">inventory-response-items:</span>
+ <span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/inventory-response-items">inventory-response-items</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-inventory-response-items" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/inventory-response-items"></a>inventory-response-items:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Container for inventory items in response list</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="inventory-response-item">
+ <span class="json-property-name">inventory-response-item:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/inventory-response-item">inventory-response-item</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-ipsec-configuration" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/ipsec-configuration"></a>ipsec-configuration:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>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</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)</li>
+<li>FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)</li>
+<li>IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="ipsec-configuration-id">
+ <span class="json-property-name">ipsec-configuration-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>UUID of this configuration</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="requested-vig-address-type">
+ <span class="json-property-name">requested-vig-address-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Indicate the type of VIG server like AVPN, INTERNET, BOTH</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="requested-encryption-strength">
+ <span class="json-property-name">requested-encryption-strength:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="requested-dmz-type">
+ <span class="json-property-name">requested-dmz-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>ATT can offer a shared DMZ or a DMZ specific to a customer</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="shared-dmz-network-address">
+ <span class="json-property-name">shared-dmz-network-address:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Network address of shared DMZ</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="requested-customer-name">
+ <span class="json-property-name">requested-customer-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>If the DMZ is a custom DMZ, this field will indicate the customer information</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="ike-version">
+ <span class="json-property-name">ike-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>can be 1 or 2</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="ikev1-authentication">
+ <span class="json-property-name">ikev1-authentication:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Contains values like md5, sha1, sha256, sha384</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="ikev1-encryption">
+ <span class="json-property-name">ikev1-encryption:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Encyption values like 3des-cbc, des-cbc, aes-128-cbc,ƂĀ aes-192-cbc, aes-265-cbc</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="ikev1-dh-group">
+ <span class="json-property-name">ikev1-dh-group:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="ikev1-am-group-id">
+ <span class="json-property-name">ikev1-am-group-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Group name defined in VIG for clients using aggressive mode</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="ikev1-am-password">
+ <span class="json-property-name">ikev1-am-password:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>pre-shared key for the above group name</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="ikev1-sa-lifetime">
+ <span class="json-property-name">ikev1-sa-lifetime:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Lifetime for IKEv1 SA</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="ipsec-authentication">
+ <span class="json-property-name">ipsec-authentication:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>md5, sha1, sha256, sha384</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="ipsec-encryption">
+ <span class="json-property-name">ipsec-encryption:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>3des-cbc, des-cbc, aes-128-cbc,ƂĀ aes-192-cbc, aes-265-cbc</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="ipsec-sa-lifetime">
+ <span class="json-property-name">ipsec-sa-lifetime:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Life time for IPSec SA</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="ipsec-pfs">
+ <span class="json-property-name">ipsec-pfs:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>enable PFS or not</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="xauth-userid">
+ <span class="json-property-name">xauth-userid:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>user ID for xAuth, sm-user,ucpeHostName,nmteHostName</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="xauth-user-password">
+ <span class="json-property-name">xauth-user-password:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Encrypted using the Juniper $9$ algorithm</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="dpd-interval">
+ <span class="json-property-name">dpd-interval:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>The time between DPD probe</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="dpd-frequency">
+ <span class="json-property-name">dpd-frequency:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Maximum number of DPD before claiming the tunnel is down</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="vig-servers">
+ <span class="json-property-name">vig-servers:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/vig-server">vig-server</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-ipsec-configurations" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/ipsec-configurations"></a>ipsec-configurations:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="ipsec-configuration">
+ <span class="json-property-name">ipsec-configuration:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/ipsec-configuration">ipsec-configuration</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-key-data" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/key-data"></a>key-data:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="key-name">
+ <span class="json-property-name">key-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="key-value">
+ <span class="json-property-name">key-value:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-l-interface" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/l-interface"></a>l-interface:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Logical interfaces, e.g., a vnic.</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)</li>
+<li>TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)</li>
+<li>TO instance-group( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)</li>
+<li>TO l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)</li>
+<li>TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)</li>
+<li>TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)</li>
+<li>TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)</li>
+<li>TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)</li>
+<li>FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY)</li>
+<li>FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)</li>
+<li>FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)</li>
+<li>FROM logical-link( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY)</li>
+<li>FROM logical-link( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY)</li>
+<li>FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)</li>
+<li>FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)</li>
+<li>FROM configuration( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY)</li>
+<li>FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)</li>
+<li>FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)</li>
+<li>L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,LOGICAL-LINK,SRIOV-VF,VLAN</li>
+<li>L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="interface-name">
+ <span class="json-property-name">interface-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Name given to the interface</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="interface-role">
+ <span class="json-property-name">interface-role:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>E.g., CUSTOMER, UPLINK, etc.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="v6-wan-link-ip">
+ <span class="json-property-name">v6-wan-link-ip:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="selflink">
+ <span class="json-property-name">selflink:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>URL to endpoint where AAI can get more details</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="interface-id">
+ <span class="json-property-name">interface-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>ID of interface</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="macaddr">
+ <span class="json-property-name">macaddr:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>MAC address for the interface</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="network-name">
+ <span class="json-property-name">network-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Name of the network</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="management-option">
+ <span class="json-property-name">management-option:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Whether A&AI should be managing this interface of not. Could have value like CUSTOMER</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="interface-description">
+ <span class="json-property-name">interface-description:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Human friendly text regarding this interface.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="is-port-mirrored">
+ <span class="json-property-name">is-port-mirrored:</span>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="in-maint">
+ <span class="json-property-name">in-maint:</span>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="prov-status">
+ <span class="json-property-name">prov-status:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV].</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="is-ip-unnumbered">
+ <span class="json-property-name">is-ip-unnumbered:</span>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="allowed-address-pairs">
+ <span class="json-property-name">allowed-address-pairs:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Freeform field for storing an ip address, list of ip addresses or a subnet block.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vlans">
+ <span class="json-property-name">vlans:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/vlan">vlan</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="sriov-vfs">
+ <span class="json-property-name">sriov-vfs:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/sriov-vf">sriov-vf</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="l-interfaces">
+ <span class="json-property-name">l-interfaces:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/l-interface">l-interface</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="l3-interface-ipv4-address-list">
+ <span class="json-property-name">l3-interface-ipv4-address-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">l3-interface-ipv4-address-list</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="l3-interface-ipv6-address-list">
+ <span class="json-property-name">l3-interface-ipv6-address-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">l3-interface-ipv6-address-list</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-l-interfaces" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/l-interfaces"></a>l-interfaces:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Collection of logical interfaces.</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="l-interface">
+ <span class="json-property-name">l-interface:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/l-interface">l-interface</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-l3-interface-ipv4-address-list" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/l3-interface-ipv4-address-list"></a>l3-interface-ipv4-address-list:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>IPv4 Address Range</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO instance-group( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)</li>
+<li>TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)</li>
+<li>TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)</li>
+<li>TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)</li>
+<li>TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)</li>
+<li>TO vnfc( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="l3-interface-ipv4-address">
+ <span class="json-property-name">l3-interface-ipv4-address:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>IP address</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="l3-interface-ipv4-prefix-length">
+ <span class="json-property-name">l3-interface-ipv4-prefix-length:</span>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Prefix length, 32 for single address</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vlan-id-inner">
+ <span class="json-property-name">vlan-id-inner:</span>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Inner VLAN tag</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vlan-id-outer">
+ <span class="json-property-name">vlan-id-outer:</span>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Outer VLAN tag</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="is-floating">
+ <span class="json-property-name">is-floating:</span>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Indicator of fixed or floating address</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="neutron-network-id">
+ <span class="json-property-name">neutron-network-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Neutron network id of the interface that address belongs to</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="neutron-subnet-id">
+ <span class="json-property-name">neutron-subnet-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Neutron id of subnet that address belongs to</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-l3-interface-ipv6-address-list" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/l3-interface-ipv6-address-list"></a>l3-interface-ipv6-address-list:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>IPv6 Address Range</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO instance-group( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)</li>
+<li>TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)</li>
+<li>TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)</li>
+<li>TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)</li>
+<li>TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)</li>
+<li>TO vnfc( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="l3-interface-ipv6-address">
+ <span class="json-property-name">l3-interface-ipv6-address:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>IP address</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="l3-interface-ipv6-prefix-length">
+ <span class="json-property-name">l3-interface-ipv6-prefix-length:</span>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Prefix length, 128 for single address</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vlan-id-inner">
+ <span class="json-property-name">vlan-id-inner:</span>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Inner VLAN tag</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vlan-id-outer">
+ <span class="json-property-name">vlan-id-outer:</span>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Outer VLAN tag</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="is-floating">
+ <span class="json-property-name">is-floating:</span>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Indicator of fixed or floating address</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="neutron-network-id">
+ <span class="json-property-name">neutron-network-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Neutron network id of the interface that address belongs to</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="neutron-subnet-id">
+ <span class="json-property-name">neutron-subnet-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Neutron id of subnet that address belongs to</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-l3-network" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/l3-network"></a>l3-network:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Generic network definition</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO instance-group( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)</li>
+<li>TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)</li>
+<li>TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)</li>
+<li>TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)</li>
+<li>TO model-ver( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One)</li>
+<li>FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)</li>
+<li>FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)</li>
+<li>FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)</li>
+<li>FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)</li>
+<li>FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)</li>
+<li>FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)</li>
+<li>FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)</li>
+<li>FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)</li>
+<li>FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)</li>
+<li>FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)</li>
+<li>FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)</li>
+<li>FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)</li>
+<li>L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="network-id">
+ <span class="json-property-name">network-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Network ID, should be uuid. Unique across A&AI.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="network-name">
+ <span class="json-property-name">network-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Name of the network, governed by some naming convention..</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="network-type">
+ <span class="json-property-name">network-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Type of the network - who defines these values?</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="network-role">
+ <span class="json-property-name">network-role:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Role the network plans - who defines these values?</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="network-technology">
+ <span class="json-property-name">network-technology:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Network technology - who defines these values?</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="neutron-network-id">
+ <span class="json-property-name">neutron-network-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Neutron network id of this Interface</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="is-bound-to-vpn">
+ <span class="json-property-name">is-bound-to-vpn:</span>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="service-id">
+ <span class="json-property-name">service-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="network-role-instance">
+ <span class="json-property-name">network-role-instance:</span>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>network role instance</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="orchestration-status">
+ <span class="json-property-name">orchestration-status:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Orchestration status of this VNF, mastered by MSO</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="heat-stack-id">
+ <span class="json-property-name">heat-stack-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="mso-catalog-key">
+ <span class="json-property-name">mso-catalog-key:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Corresponds to the SDN-C catalog id used to configure this VCE</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="contrail-network-fqdn">
+ <span class="json-property-name">contrail-network-fqdn:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Contrail FQDN for the network</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="model-invariant-id">
+ <span class="json-property-name">model-invariant-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>the ASDC model id for this resource or service model.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="model-version-id">
+ <span class="json-property-name">model-version-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>the ASDC model version for this resource or service model.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="persona-model-version">
+ <span class="json-property-name">persona-model-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>the ASDC model version for this resource or service model.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="model-customization-id">
+ <span class="json-property-name">model-customization-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>captures the id of all the configuration used to customize the resource for the service.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="widget-model-id">
+ <span class="json-property-name">widget-model-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="widget-model-version">
+ <span class="json-property-name">widget-model-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="physical-network-name">
+ <span class="json-property-name">physical-network-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Name associated with the physical network.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="is-provider-network">
+ <span class="json-property-name">is-provider-network:</span>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="is-shared-network">
+ <span class="json-property-name">is-shared-network:</span>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="is-external-network">
+ <span class="json-property-name">is-external-network:</span>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="selflink">
+ <span class="json-property-name">selflink:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Path to the controller object.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="operational-status">
+ <span class="json-property-name">operational-status:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Indicator for whether the resource is considered operational.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="subnets">
+ <span class="json-property-name">subnets:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/subnet">subnet</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="ctag-assignments">
+ <span class="json-property-name">ctag-assignments:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/ctag-assignment">ctag-assignment</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="segmentation-assignments">
+ <span class="json-property-name">segmentation-assignments:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/segmentation-assignment">segmentation-assignment</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-l3-networks" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/l3-networks"></a>l3-networks:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="l3-network">
+ <span class="json-property-name">l3-network:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/l3-network">l3-network</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-lag-interface" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/lag-interface"></a>lag-interface:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Link aggregate interface</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)</li>
+<li>TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)</li>
+<li>TO logical-link( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)</li>
+<li>TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)</li>
+<li>TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)</li>
+<li>TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)</li>
+<li>TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)</li>
+<li>FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)</li>
+<li>FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)</li>
+<li>LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE</li>
+<li>LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="interface-name">
+ <span class="json-property-name">interface-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Name that identifies the link aggregate interface</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="interface-description">
+ <span class="json-property-name">interface-description:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Human friendly text regarding this interface.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="speed-value">
+ <span class="json-property-name">speed-value:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Captures the numeric part of the speed</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="speed-units">
+ <span class="json-property-name">speed-units:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Captures the units corresponding to the speed</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="interface-id">
+ <span class="json-property-name">interface-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>ID of interface</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="interface-role">
+ <span class="json-property-name">interface-role:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="prov-status">
+ <span class="json-property-name">prov-status:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="in-maint">
+ <span class="json-property-name">in-maint:</span>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="l-interfaces">
+ <span class="json-property-name">l-interfaces:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/l-interface">l-interface</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-lag-interfaces" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/lag-interfaces"></a>lag-interfaces:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Collection of link aggregate interfaces.</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="lag-interface">
+ <span class="json-property-name">lag-interface:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/lag-interface">lag-interface</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-lag-link" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/lag-link"></a>lag-link:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>LAG links can connect lag-interfaces</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)</li>
+<li>FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="link-name">
+ <span class="json-property-name">link-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Alphabetical concatenation of lag-interface names</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-lag-links" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/lag-links"></a>lag-links:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Collection of link aggregation connections</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="lag-link">
+ <span class="json-property-name">lag-link:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/lag-link">lag-link</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-license" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/license"></a>license:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Metadata for license group.</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)</li>
+<li>TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="group-uuid">
+ <span class="json-property-name">group-uuid:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Unique ID for the license group the resource belongs to, should be uuid.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-uuid">
+ <span class="json-property-name">resource-uuid:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Unique ID of a license resource.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Concurrency value</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-licenses" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/licenses"></a>licenses:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="license">
+ <span class="json-property-name">license:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/license">license</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-line-of-business" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/line-of-business"></a>line-of-business:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>describes a line-of-business</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="line-of-business-name">
+ <span class="json-property-name">line-of-business-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Name of the line-of-business (product)</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-lines-of-business" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/lines-of-business"></a>lines-of-business:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Collection of lines-of-business</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="line-of-business">
+ <span class="json-property-name">line-of-business:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/line-of-business">line-of-business</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-logical-link" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/logical-link"></a>logical-link:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Logical links generally connect l-interfaces but are used to express logical connectivity between two points</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO l-interface( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY)</li>
+<li>TO l-interface( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY)</li>
+<li>TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)</li>
+<li>TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)</li>
+<li>TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)</li>
+<li>TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)</li>
+<li>TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)</li>
+<li>TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)</li>
+<li>TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)</li>
+<li>TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)</li>
+<li>TO model-ver( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One)</li>
+<li>FROM configuration( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)</li>
+<li>FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)</li>
+<li>FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)</li>
+<li>FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)</li>
+<li>FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)</li>
+<li>FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)</li>
+<li>FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="link-name">
+ <span class="json-property-name">link-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="in-maint">
+ <span class="json-property-name">in-maint:</span>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="link-type">
+ <span class="json-property-name">link-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Type of logical link, e.g., evc</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="speed-value">
+ <span class="json-property-name">speed-value:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Captures the numeric part of the speed</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="speed-units">
+ <span class="json-property-name">speed-units:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Captures the units corresponding to the speed</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="ip-version">
+ <span class="json-property-name">ip-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>v4, v6, or ds for dual stack</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="routing-protocol">
+ <span class="json-property-name">routing-protocol:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>For example, static or BGP</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="model-invariant-id">
+ <span class="json-property-name">model-invariant-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>the ASDC model id for this resource or service model.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="model-version-id">
+ <span class="json-property-name">model-version-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>the ASDC model version for this resource or service model.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="persona-model-version">
+ <span class="json-property-name">persona-model-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>the ASDC model version for this resource or service model.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="widget-model-id">
+ <span class="json-property-name">widget-model-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="widget-model-version">
+ <span class="json-property-name">widget-model-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="operational-status">
+ <span class="json-property-name">operational-status:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Indication of operational status of the logical link.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="prov-status">
+ <span class="json-property-name">prov-status:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Trigger for operational monitoring of this VNF by BAU Service Assurance systems.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="link-role">
+ <span class="json-property-name">link-role:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Indication of the network use of the logical link.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="link-name2">
+ <span class="json-property-name">link-name2:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Alias or alternate name (CLCI or D1 name).</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="link-id">
+ <span class="json-property-name">link-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>UUID of the logical-link, SDNC generates this.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="circuit-id">
+ <span class="json-property-name">circuit-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Circuit id</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="purpose">
+ <span class="json-property-name">purpose:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Reason for this entity, role it is playing</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-logical-links" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/logical-links"></a>logical-links:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Collection of logical connections</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="logical-link">
+ <span class="json-property-name">logical-link:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/logical-link">logical-link</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-metadata" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/metadata"></a>metadata:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Collection of metadatum (key/value pairs)</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="metadatum">
+ <span class="json-property-name">metadatum:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/metadatum">metadatum</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-metadatum" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/metadatum"></a>metadatum:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Key/value pairs</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO configuration( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)</li>
+<li>TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)</li>
+<li>TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)</li>
+<li>TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)</li>
+<li>TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="metaname">
+ <span class="json-property-name">metaname:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="metaval">
+ <span class="json-property-name">metaval:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-model" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/model"></a>model:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)</li>
+<li>FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)</li>
+<li>FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)</li>
+<li>FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)</li>
+<li>FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)</li>
+<li>MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT</li>
+<li>MODEL is DELETED when these are DELETED MODEL-VER</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="model-invariant-id">
+ <span class="json-property-name">model-invariant-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Unique identifier corresponding to the main definition of a model in ASDC</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="model-type">
+ <span class="json-property-name">model-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Type of the model, e.g., service, resource, widget, etc.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="model-vers">
+ <span class="json-property-name">model-vers:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/model-ver">model-ver</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-model-and-named-query-search" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/model-and-named-query-search"></a>model-and-named-query-search:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="top-node-type">
+ <span class="json-property-name">top-node-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="secondary-filter-cut-point">
+ <span class="json-property-name">secondary-filter-cut-point:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="query-parameters">
+ <span class="json-property-name">query-parameters:</span>
+ <span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/query-parameters">query-parameters</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="instance-filters">
+ <span class="json-property-name">instance-filters:</span>
+ <span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/instance-filters">instance-filters</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="secondary-filts">
+ <span class="json-property-name">secondary-filts:</span>
+ <span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/secondary-filts">secondary-filts</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-model-constraint" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/model-constraint"></a>model-constraint:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>This is how we would capture constraints defining allowed sets of elements.</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)</li>
+<li>FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)</li>
+<li>MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="model-constraint-uuid">
+ <span class="json-property-name">model-constraint-uuid:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="constrained-element-set-uuid-to-replace">
+ <span class="json-property-name">constrained-element-set-uuid-to-replace:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="constrained-element-sets">
+ <span class="json-property-name">constrained-element-sets:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/constrained-element-set">constrained-element-set</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-model-constraints" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/model-constraints"></a>model-constraints:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="model-constraint">
+ <span class="json-property-name">model-constraint:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/model-constraint">model-constraint</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-model-element" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/model-element"></a>model-element:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Defines how other models combine to make up a higher-level model.</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)</li>
+<li>TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)</li>
+<li>TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)</li>
+<li>TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)</li>
+<li>FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)</li>
+<li>FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)</li>
+<li>FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)</li>
+<li>MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="model-element-uuid">
+ <span class="json-property-name">model-element-uuid:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="new-data-del-flag">
+ <span class="json-property-name">new-data-del-flag:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Indicates whether this element was created as part of instantiation from this model</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="cardinality">
+ <span class="json-property-name">cardinality:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>How many of this type of element are required/allowed</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="linkage-points">
+ <span class="json-property-name">linkage-points:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="model-elements">
+ <span class="json-property-name">model-elements:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/model-element">model-element</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="model-constraints">
+ <span class="json-property-name">model-constraints:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/model-constraint">model-constraint</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-model-elements" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/model-elements"></a>model-elements:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="model-element">
+ <span class="json-property-name">model-element:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/model-element">model-element</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-model-ver" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/model-ver"></a>model-ver:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)</li>
+<li>FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)</li>
+<li>FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)</li>
+<li>FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)</li>
+<li>FROM allotted-resource( allotted-resource org.onap.relationships.inventory.IsA model-ver, Many2One)</li>
+<li>FROM generic-vnf( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One)</li>
+<li>FROM l3-network( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One)</li>
+<li>FROM logical-link( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One)</li>
+<li>FROM service-instance( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One)</li>
+<li>FROM vf-module( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One)</li>
+<li>MODEL-VER cannot be deleted if linked to MODEL-ELEMENT</li>
+<li>MODEL-VER is DELETED when these are DELETED METADATUM,MODEL-ELEMENT</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="model-version-id">
+ <span class="json-property-name">model-version-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Unique identifier corresponding to one version of a model in ASDC</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="model-name">
+ <span class="json-property-name">model-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Name of the model, which can change from version to version.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="model-version">
+ <span class="json-property-name">model-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Version</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="distribution-status">
+ <span class="json-property-name">distribution-status:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Distribution Status</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="model-description">
+ <span class="json-property-name">model-description:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Description</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="model-elements">
+ <span class="json-property-name">model-elements:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/model-element">model-element</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="metadata">
+ <span class="json-property-name">metadata:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/metadatum">metadatum</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-model-vers" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/model-vers"></a>model-vers:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="model-ver">
+ <span class="json-property-name">model-ver:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/model-ver">model-ver</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-models" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/models"></a>models:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="model">
+ <span class="json-property-name">model:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/model">model</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-multicast-configuration" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/multicast-configuration"></a>multicast-configuration:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="multicast-configuration-id">
+ <span class="json-property-name">multicast-configuration-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Unique id of multicast configuration.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="multicast-protocol">
+ <span class="json-property-name">multicast-protocol:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>protocol of multicast configuration</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="rp-type">
+ <span class="json-property-name">rp-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>rp type of multicast configuration</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-multicast-configurations" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/multicast-configurations"></a>multicast-configurations:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>multicast configuration of generic-vnf ip-address</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="multicast-configuration">
+ <span class="json-property-name">multicast-configuration:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/multicast-configuration">multicast-configuration</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-named-queries" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/named-queries"></a>named-queries:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="named-query">
+ <span class="json-property-name">named-query:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/named-query">named-query</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-named-query" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/named-query"></a>named-query:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>TBD</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)</li>
+<li>TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)</li>
+<li>FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)</li>
+<li>NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="named-query-uuid">
+ <span class="json-property-name">named-query-uuid:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="named-query-name">
+ <span class="json-property-name">named-query-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="named-query-version">
+ <span class="json-property-name">named-query-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="required-input-param">
+ <span class="json-property-name">required-input-param:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="description">
+ <span class="json-property-name">description:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="named-query-elements">
+ <span class="json-property-name">named-query-elements:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/named-query-element">named-query-element</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-named-query-element" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/named-query-element"></a>named-query-element:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>TBD</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)</li>
+<li>TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)</li>
+<li>TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)</li>
+<li>FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)</li>
+<li>FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)</li>
+<li>FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)</li>
+<li>NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="named-query-element-uuid">
+ <span class="json-property-name">named-query-element-uuid:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="property-collect-list">
+ <span class="json-property-name">property-collect-list:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="property-limit-desc">
+ <span class="json-property-name">property-limit-desc:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="do-not-output">
+ <span class="json-property-name">do-not-output:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="named-query-elements">
+ <span class="json-property-name">named-query-elements:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/named-query-element">named-query-element</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="related-lookups">
+ <span class="json-property-name">related-lookups:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/related-lookup">related-lookup</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="property-constraints">
+ <span class="json-property-name">property-constraints:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/property-constraint">property-constraint</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-named-query-elements" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/named-query-elements"></a>named-query-elements:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="named-query-element">
+ <span class="json-property-name">named-query-element:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/named-query-element">named-query-element</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-network" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/network"></a>network:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Namespace for network inventory resources.</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="logical-links">
+ <span class="json-property-name">logical-links:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/logical-link">logical-link</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="site-pair-sets">
+ <span class="json-property-name">site-pair-sets:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/site-pair-set">site-pair-set</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="vpn-bindings">
+ <span class="json-property-name">vpn-bindings:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/vpn-binding">vpn-binding</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="vpls-pes">
+ <span class="json-property-name">vpls-pes:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/vpls-pe">vpls-pe</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="multicast-configurations">
+ <span class="json-property-name">multicast-configurations:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/multicast-configuration">multicast-configuration</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="vces">
+ <span class="json-property-name">vces:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/vce">vce</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="vnfcs">
+ <span class="json-property-name">vnfcs:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/vnfc">vnfc</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="l3-networks">
+ <span class="json-property-name">l3-networks:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/l3-network">l3-network</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="network-policies">
+ <span class="json-property-name">network-policies:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/network-policy">network-policy</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="generic-vnfs">
+ <span class="json-property-name">generic-vnfs:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/generic-vnf">generic-vnf</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="lag-links">
+ <span class="json-property-name">lag-links:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/lag-link">lag-link</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="newvces">
+ <span class="json-property-name">newvces:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/newvce">newvce</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="pnfs">
+ <span class="json-property-name">pnfs:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/pnf">pnf</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="physical-links">
+ <span class="json-property-name">physical-links:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/physical-link">physical-link</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="ipsec-configurations">
+ <span class="json-property-name">ipsec-configurations:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/ipsec-configuration">ipsec-configuration</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="route-table-references">
+ <span class="json-property-name">route-table-references:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/route-table-reference">route-table-reference</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="instance-groups">
+ <span class="json-property-name">instance-groups:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/instance-group">instance-group</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="zones">
+ <span class="json-property-name">zones:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/zone">zone</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="configurations">
+ <span class="json-property-name">configurations:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/configuration">configuration</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="forwarding-paths">
+ <span class="json-property-name">forwarding-paths:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/forwarding-path">forwarding-path</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-network-policies" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/network-policies"></a>network-policies:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="network-policy">
+ <span class="json-property-name">network-policy:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/network-policy">network-policy</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-network-policy" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/network-policy"></a>network-policy:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)</li>
+<li>FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="network-policy-id">
+ <span class="json-property-name">network-policy-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>UUID representing unique key to this instance</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="network-policy-fqdn">
+ <span class="json-property-name">network-policy-fqdn:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Contrail FQDN for the policy</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="heat-stack-id">
+ <span class="json-property-name">heat-stack-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>ID for the openStack Heat instance</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-network-profile" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/network-profile"></a>network-profile:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Network profile populated by SDN-GP for SNMP</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="nm-profile-name">
+ <span class="json-property-name">nm-profile-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Unique name of network profile.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="community-string">
+ <span class="json-property-name">community-string:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Encrypted SNMP community string</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-network-profiles" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/network-profiles"></a>network-profiles:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Collection of network profiles</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="network-profile">
+ <span class="json-property-name">network-profile:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/network-profile">network-profile</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-newvce" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/newvce"></a>newvce:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)</li>
+<li>NEWVCE is DELETED when these are DELETED L-INTERFACE</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="vnf-id2">
+ <span class="json-property-name">vnf-id2:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Unique id of VNF, can't use same attribute name right now until we promote this new object</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vnf-name">
+ <span class="json-property-name">vnf-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Name of VNF.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vnf-name2">
+ <span class="json-property-name">vnf-name2:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Alternate name of VNF.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vnf-type">
+ <span class="json-property-name">vnf-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>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.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="prov-status">
+ <span class="json-property-name">prov-status:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Trigger for operational monitoring of this VNF by BAU Service Assurance systems.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="operational-status">
+ <span class="json-property-name">operational-status:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Indicator for whether the resource is considered operational</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="license-key">
+ <span class="json-property-name">license-key:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>OBSOLETE - do not use</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="ipv4-oam-address">
+ <span class="json-property-name">ipv4-oam-address:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>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).</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="equipment-role">
+ <span class="json-property-name">equipment-role:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Client should send valid enumerated value.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="ipv4-loopback0-address">
+ <span class="json-property-name">ipv4-loopback0-address:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>v4 Loopback0 address</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="orchestration-status">
+ <span class="json-property-name">orchestration-status:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Orchestration status of this VNF, mastered by MSO.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="heat-stack-id">
+ <span class="json-property-name">heat-stack-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="mso-catalog-key">
+ <span class="json-property-name">mso-catalog-key:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Corresponds to the SDN-C catalog id used to configure this VCE</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="l-interfaces">
+ <span class="json-property-name">l-interfaces:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/l-interface">l-interface</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-newvces" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/newvces"></a>newvces:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="newvce">
+ <span class="json-property-name">newvce:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/newvce">newvce</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-notification-event" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/notification-event"></a>notification-event:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="cambria.partition">
+ <span class="json-property-name">cambria.partition:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="notification-event-header">
+ <span class="json-property-name">notification-event-header:</span>
+ <span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/notification-event-header">notification-event-header</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-notification-event-header" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/notification-event-header"></a>notification-event-header:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="id">
+ <span class="json-property-name">id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="timestamp">
+ <span class="json-property-name">timestamp:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="source-name">
+ <span class="json-property-name">source-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="domain">
+ <span class="json-property-name">domain:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="sequence-number">
+ <span class="json-property-name">sequence-number:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="severity">
+ <span class="json-property-name">severity:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="event-type">
+ <span class="json-property-name">event-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="version">
+ <span class="json-property-name">version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="action">
+ <span class="json-property-name">action:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="entity-type">
+ <span class="json-property-name">entity-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="top-entity-type">
+ <span class="json-property-name">top-entity-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="entity-link">
+ <span class="json-property-name">entity-link:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="status">
+ <span class="json-property-name">status:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-notify" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/notify"></a>notify:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="event-id">
+ <span class="json-property-name">event-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="node-type">
+ <span class="json-property-name">node-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="event-trigger">
+ <span class="json-property-name">event-trigger:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="selflink">
+ <span class="json-property-name">selflink:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="key-data">
+ <span class="json-property-name">key-data:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/key-data">key-data</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-oam-network" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/oam-network"></a>oam-network:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>OAM network, to be deprecated shortly. Do not use for new purposes.</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)</li>
+<li>TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)</li>
+<li>TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="network-uuid">
+ <span class="json-property-name">network-uuid:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>UUID of the network. Unique across a cloud-region</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="network-name">
+ <span class="json-property-name">network-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Name of the network.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="cvlan-tag">
+ <span class="json-property-name">cvlan-tag:</span>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>cvlan-id</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="ipv4-oam-gateway-address">
+ <span class="json-property-name">ipv4-oam-gateway-address:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for VNF firewall rule so customer cannot send customer traffic over this oam network</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="ipv4-oam-gateway-address-prefix-length">
+ <span class="json-property-name">ipv4-oam-gateway-address-prefix-length:</span>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for VNF firewall rule so customer cannot send customer traffic over this oam network</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-oam-networks" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/oam-networks"></a>oam-networks:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Collection of OAM networks, to be deprecated shortly. Do not use for new purposes.</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="oam-network">
+ <span class="json-property-name">oam-network:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/oam-network">oam-network</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-operational-environment" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/operational-environment"></a>operational-environment:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>It is a logical partition of the cloud which allows to have multiple environments in the production AIC.</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)</li>
+<li>FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="operational-environment-id">
+ <span class="json-property-name">operational-environment-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>UUID of an operational environment</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="operational-environment-name">
+ <span class="json-property-name">operational-environment-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Operational Environment name</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="operational-environment-type">
+ <span class="json-property-name">operational-environment-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Operational Environment Type.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="operational-environment-status">
+ <span class="json-property-name">operational-environment-status:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Status</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="tenant-context">
+ <span class="json-property-name">tenant-context:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Tenant Context.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="workload-context">
+ <span class="json-property-name">workload-context:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Workload Context.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-operational-environments" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/operational-environments"></a>operational-environments:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>a logical partition of the cloud which allows to have multiple environments in the production AIC.</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="operational-environment">
+ <span class="json-property-name">operational-environment:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/operational-environment">operational-environment</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-overloaded-model" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/overloaded-model"></a>overloaded-model:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Allows for legacy POST of old-style and new-style models</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="model-invariant-id">
+ <span class="json-property-name">model-invariant-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Unique identifier corresponding to the main definition of a model in ASDC</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="model-name-version-id">
+ <span class="json-property-name">model-name-version-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Unique identifier corresponding to one version of a model in ASDC</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="model-type">
+ <span class="json-property-name">model-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Type of the model, e.g., service, resource, widget, etc.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="model-name">
+ <span class="json-property-name">model-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Name of the model, which can change from version to version.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="model-id">
+ <span class="json-property-name">model-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Invariant unique ID which does not change from version to version</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="model-version">
+ <span class="json-property-name">model-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Version</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="model-description">
+ <span class="json-property-name">model-description:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Description</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="model-vers">
+ <span class="json-property-name">model-vers:</span>
+ <span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/model-vers">model-vers</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship-list">relationship-list</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-owning-entities" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/owning-entities"></a>owning-entities:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Collection of owning-entities</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="owning-entity">
+ <span class="json-property-name">owning-entity:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/owning-entity">owning-entity</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-owning-entity" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/owning-entity"></a>owning-entity:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>describes an owning-entity</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="owning-entity-id">
+ <span class="json-property-name">owning-entity-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>UUID of an owning entity</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="owning-entity-name">
+ <span class="json-property-name">owning-entity-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Owning entity name</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-p-interface" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/p-interface"></a>p-interface:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Physical interface (e.g., nic)</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)</li>
+<li>TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)</li>
+<li>TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)</li>
+<li>TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)</li>
+<li>TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)</li>
+<li>FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)</li>
+<li>FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)</li>
+<li>FROM sriov-pf( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)</li>
+<li>FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)</li>
+<li>P-INTERFACE is DELETED when these are DELETED L-INTERFACE,SRIOV-PF</li>
+<li>P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="interface-name">
+ <span class="json-property-name">interface-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Name that identifies the physical interface</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="selflink">
+ <span class="json-property-name">selflink:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>URL to endpoint where AAI can get more details.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="speed-value">
+ <span class="json-property-name">speed-value:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Captures the numeric part of the speed</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="speed-units">
+ <span class="json-property-name">speed-units:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Captures the units corresponding to the speed</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="port-description">
+ <span class="json-property-name">port-description:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Nature of the services and connectivity on this port.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="equipment-identifier">
+ <span class="json-property-name">equipment-identifier:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>CLEI or other specification for p-interface hardware.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="interface-role">
+ <span class="json-property-name">interface-role:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Role specification for p-interface hardware.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="interface-type">
+ <span class="json-property-name">interface-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Indicates the physical properties of the interface.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="prov-status">
+ <span class="json-property-name">prov-status:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="mac-addresss">
+ <span class="json-property-name">mac-addresss:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>MAC Address of the p-interface.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="in-maint">
+ <span class="json-property-name">in-maint:</span>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="inv-status">
+ <span class="json-property-name">inv-status:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>inventory status</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="sriov-pfs">
+ <span class="json-property-name">sriov-pfs:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/sriov-pf">sriov-pf</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="l-interfaces">
+ <span class="json-property-name">l-interfaces:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/l-interface">l-interface</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-p-interfaces" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/p-interfaces"></a>p-interfaces:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Collection of physical interfaces.</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="p-interface">
+ <span class="json-property-name">p-interface:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/p-interface">p-interface</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-physical-link" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/physical-link"></a>physical-link:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Collection of physical connections, typically between p-interfaces</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="link-name">
+ <span class="json-property-name">link-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="speed-value">
+ <span class="json-property-name">speed-value:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Captures the numeric part of the speed</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="speed-units">
+ <span class="json-property-name">speed-units:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Captures the units corresponding to the speed</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="circuit-id">
+ <span class="json-property-name">circuit-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Circuit it</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="dual-mode">
+ <span class="json-property-name">dual-mode:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Dual access mode (e.g., primary, secondary</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="management-option">
+ <span class="json-property-name">management-option:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>To provide information on who manages this circuit. A&AI or 3rd party transport provider</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="service-provider-name">
+ <span class="json-property-name">service-provider-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Name of the service Provider on this link.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="service-provider-bandwidth-up-value">
+ <span class="json-property-name">service-provider-bandwidth-up-value:</span>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Upstream Bandwidth value agreed with the service provider</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="service-provider-bandwidth-up-units">
+ <span class="json-property-name">service-provider-bandwidth-up-units:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Units for the upstream BW value</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="service-provider-bandwidth-down-value">
+ <span class="json-property-name">service-provider-bandwidth-down-value:</span>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Downstream Bandwidth value agreed with the service provider</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="service-provider-bandwidth-down-units">
+ <span class="json-property-name">service-provider-bandwidth-down-units:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Units for downstream BW value</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-physical-links" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/physical-links"></a>physical-links:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Collection of physical connections, typically between p-interfaces</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="physical-link">
+ <span class="json-property-name">physical-link:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/physical-link">physical-link</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-platform" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/platform"></a>platform:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>describes a platform</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="platform-name">
+ <span class="json-property-name">platform-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Name of the platform</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-platforms" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/platforms"></a>platforms:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Collection of platforms</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="platform">
+ <span class="json-property-name">platform:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/platform">platform</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-pnf" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/pnf"></a>pnf:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>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.</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)</li>
+<li>TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)</li>
+<li>TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)</li>
+<li>FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc has pnf, One2Many)</li>
+<li>FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY)</li>
+<li>FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)</li>
+<li>FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)</li>
+<li>FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)</li>
+<li>FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)</li>
+<li>FROM configuration( configuration org.onap.relationships.inventory.AppliesTo pnf, ONE2MANY)</li>
+<li>PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="pnf-name">
+ <span class="json-property-name">pnf-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>unique name of Physical Network Function.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="pnf-name2">
+ <span class="json-property-name">pnf-name2:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>name of Physical Network Function.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="selflink">
+ <span class="json-property-name">selflink:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>URL to endpoint where AAI can get more details.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="pnf-name2-source">
+ <span class="json-property-name">pnf-name2-source:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>source of name2</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="pnf-id">
+ <span class="json-property-name">pnf-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>id of pnf</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="equip-type">
+ <span class="json-property-name">equip-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Equipment type. Source of truth should define valid values.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="equip-vendor">
+ <span class="json-property-name">equip-vendor:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Equipment vendor. Source of truth should define valid values.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="equip-model">
+ <span class="json-property-name">equip-model:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Equipment model. Source of truth should define valid values.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="management-option">
+ <span class="json-property-name">management-option:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>identifier of managed by ATT or customer</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="ipaddress-v4-oam">
+ <span class="json-property-name">ipaddress-v4-oam:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>ipv4-oam-address with new naming convention for IP addresses</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="sw-version">
+ <span class="json-property-name">sw-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>sw-version is the version of SW for the hosted application on the PNF.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="in-maint">
+ <span class="json-property-name">in-maint:</span>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="frame-id">
+ <span class="json-property-name">frame-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>ID of the physical frame (relay rack) where pnf is installed.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="serial-number">
+ <span class="json-property-name">serial-number:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Serial number of the device</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="ipaddress-v4-loopback-0">
+ <span class="json-property-name">ipaddress-v4-loopback-0:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>IPV4 Loopback 0 address</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="ipaddress-v6-loopback-0">
+ <span class="json-property-name">ipaddress-v6-loopback-0:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>IPV6 Loopback 0 address</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="ipaddress-v4-aim">
+ <span class="json-property-name">ipaddress-v4-aim:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>IPV4 AIM address</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="ipaddress-v6-aim">
+ <span class="json-property-name">ipaddress-v6-aim:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>IPV6 AIM address</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="ipaddress-v6-oam">
+ <span class="json-property-name">ipaddress-v6-oam:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>IPV6 OAM address</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="inv-status">
+ <span class="json-property-name">inv-status:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="prov-status">
+ <span class="json-property-name">prov-status:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="nf-role">
+ <span class="json-property-name">nf-role:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Nf Role is the role performed by this instance in the network.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="p-interfaces">
+ <span class="json-property-name">p-interfaces:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/p-interface">p-interface</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="lag-interfaces">
+ <span class="json-property-name">lag-interfaces:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/lag-interface">lag-interface</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-pnfs" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/pnfs"></a>pnfs:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Collection of Physical Network Functions.</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="pnf">
+ <span class="json-property-name">pnf:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/pnf">pnf</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-port-group" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/port-group"></a>port-group:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Used to capture the network interfaces of this VCE</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)</li>
+<li>FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE)</li>
+<li>PORT-GROUP is DELETED when these are DELETED CVLAN-TAG</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="interface-id">
+ <span class="json-property-name">interface-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Unique ID of the interface</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="neutron-network-id">
+ <span class="json-property-name">neutron-network-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Neutron network id of this Interface</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="neutron-network-name">
+ <span class="json-property-name">neutron-network-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Neutron network name of this Interface</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="interface-role">
+ <span class="json-property-name">interface-role:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Role assigned to this Interface, should use values as defined in ECOMP Yang models.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="port-group-id">
+ <span class="json-property-name">port-group-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Unique ID for port group in vmware</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="port-group-name">
+ <span class="json-property-name">port-group-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Likely to duplicate value of neutron network name</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="switch-name">
+ <span class="json-property-name">switch-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>DVS or standard switch name (should be non-null for port groups associated with DVS)</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="orchestration-status">
+ <span class="json-property-name">orchestration-status:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Orchestration status of this VNF, mastered by MSO</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="heat-stack-id">
+ <span class="json-property-name">heat-stack-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="mso-catalog-key">
+ <span class="json-property-name">mso-catalog-key:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Corresponds to the SDN-C catalog id used to configure this VCE</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="cvlan-tags">
+ <span class="json-property-name">cvlan-tags:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/cvlan-tag-entry">cvlan-tag-entry</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-port-groups" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/port-groups"></a>port-groups:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="port-group">
+ <span class="json-property-name">port-group:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/port-group">port-group</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-project" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/project"></a>project:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>describes the project</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="project-name">
+ <span class="json-property-name">project-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Name of the project deploying a service</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-projects" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/projects"></a>projects:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Collection of projects</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="project">
+ <span class="json-property-name">project:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/project">project</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-properties" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/properties"></a>properties:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Property holder for query properties or instance properties</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="property-name">
+ <span class="json-property-name">property-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="property-value">
+ <span class="json-property-name">property-value:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-property-constraint" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/property-constraint"></a>property-constraint:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>TBD</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="property-constraint-uuid">
+ <span class="json-property-name">property-constraint-uuid:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="constraint-type">
+ <span class="json-property-name">constraint-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="property-name">
+ <span class="json-property-name">property-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="property-value">
+ <span class="json-property-name">property-value:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-property-constraints" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/property-constraints"></a>property-constraints:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="property-constraint">
+ <span class="json-property-name">property-constraint:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/property-constraint">property-constraint</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-pserver" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/pserver"></a>pserver:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)</li>
+<li>TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)</li>
+<li>TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)</li>
+<li>TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)</li>
+<li>TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)</li>
+<li>FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)</li>
+<li>FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)</li>
+<li>FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)</li>
+<li>FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)</li>
+<li>FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)</li>
+<li>PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER</li>
+<li>PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE</li>
+<li>PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="hostname">
+ <span class="json-property-name">hostname:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Value from executing hostname on the compute node.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="ptnii-equip-name">
+ <span class="json-property-name">ptnii-equip-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>PTNII name</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="number-of-cpus">
+ <span class="json-property-name">number-of-cpus:</span>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Number of cpus</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="disk-in-gigabytes">
+ <span class="json-property-name">disk-in-gigabytes:</span>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Disk size, in GBs</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="ram-in-megabytes">
+ <span class="json-property-name">ram-in-megabytes:</span>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>RAM size, in MBs</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="equip-type">
+ <span class="json-property-name">equip-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Equipment type. Source of truth should define valid values.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="equip-vendor">
+ <span class="json-property-name">equip-vendor:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Equipment vendor. Source of truth should define valid values.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="equip-model">
+ <span class="json-property-name">equip-model:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Equipment model. Source of truth should define valid values.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="fqdn">
+ <span class="json-property-name">fqdn:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Fully-qualified domain name</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="pserver-selflink">
+ <span class="json-property-name">pserver-selflink:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>URL to endpoint where AAI can get more details</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="ipv4-oam-address">
+ <span class="json-property-name">ipv4-oam-address:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used to configure device, also used for troubleshooting and is IP used for traps generated by device.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="serial-number">
+ <span class="json-property-name">serial-number:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Serial number, may be queried</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="ipaddress-v4-loopback-0">
+ <span class="json-property-name">ipaddress-v4-loopback-0:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>IPV4 Loopback 0 address</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="ipaddress-v6-loopback-0">
+ <span class="json-property-name">ipaddress-v6-loopback-0:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>IPV6 Loopback 0 address</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="ipaddress-v4-aim">
+ <span class="json-property-name">ipaddress-v4-aim:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>IPV4 AIM address</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="ipaddress-v6-aim">
+ <span class="json-property-name">ipaddress-v6-aim:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>IPV6 AIM address</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="ipaddress-v6-oam">
+ <span class="json-property-name">ipaddress-v6-oam:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>IPV6 OAM address</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="inv-status">
+ <span class="json-property-name">inv-status:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>CANOPI's inventory status. Only set with values exactly as defined by CANOPI.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="pserver-id">
+ <span class="json-property-name">pserver-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>ID of Pserver</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="internet-topology">
+ <span class="json-property-name">internet-topology:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>internet topology of Pserver</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="in-maint">
+ <span class="json-property-name">in-maint:</span>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="pserver-name2">
+ <span class="json-property-name">pserver-name2:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>alternative pserver name</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="purpose">
+ <span class="json-property-name">purpose:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>purpose of pserver</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="prov-status">
+ <span class="json-property-name">prov-status:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="management-option">
+ <span class="json-property-name">management-option:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Indicates who owns and or manages the device.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="host-profile">
+ <span class="json-property-name">host-profile:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>The host profile that defines the configuration of the pserver.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="p-interfaces">
+ <span class="json-property-name">p-interfaces:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/p-interface">p-interface</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="lag-interfaces">
+ <span class="json-property-name">lag-interfaces:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/lag-interface">lag-interface</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-pservers" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/pservers"></a>pservers:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Collection of compute hosts.</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="pserver">
+ <span class="json-property-name">pserver:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/pserver">pserver</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-query-parameters" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/query-parameters"></a>query-parameters:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>QueryParameters for performing a named-query or model query</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="named-query">
+ <span class="json-property-name">named-query:</span>
+ <span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/named-query">named-query</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="overloaded-model">
+ <span class="json-property-name">overloaded-model:</span>
+ <span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/overloaded-model">overloaded-model</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-related-lookup" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/related-lookup"></a>related-lookup:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>TBD</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="related-lookup-uuid">
+ <span class="json-property-name">related-lookup-uuid:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="source-node-type">
+ <span class="json-property-name">source-node-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="source-node-property">
+ <span class="json-property-name">source-node-property:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="target-node-type">
+ <span class="json-property-name">target-node-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="target-node-property">
+ <span class="json-property-name">target-node-property:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="property-collect-list">
+ <span class="json-property-name">property-collect-list:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-related-lookups" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/related-lookups"></a>related-lookups:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="related-lookup">
+ <span class="json-property-name">related-lookup:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/related-lookup">related-lookup</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-related-to-property" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/related-to-property"></a>related-to-property:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="property-key">
+ <span class="json-property-name">property-key:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Key part of a key/value pair</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="property-value">
+ <span class="json-property-name">property-value:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Value part of a key/value pair</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-relationship" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/relationship"></a>relationship:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="related-to">
+ <span class="json-property-name">related-to:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>A keyword provided by A&AI to indicate type of node.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-label">
+ <span class="json-property-name">relationship-label:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>The edge label for this relationship.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="related-link">
+ <span class="json-property-name">related-link:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>URL to the object in A&AI.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-data">
+ <span class="json-property-name">relationship-data:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship-data">relationship-data</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-relationship-data" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/relationship-data"></a>relationship-data:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="relationship-key">
+ <span class="json-property-name">relationship-key:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>A keyword provided by A&AI to indicate an attribute.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-value">
+ <span class="json-property-name">relationship-value:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Value of the attribute.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-relationship-list" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/relationship-list"></a>relationship-list:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="relationship">
+ <span class="json-property-name">relationship:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-reserved-prop-names" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/reserved-prop-names"></a>reserved-prop-names:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Internal map to define some reserved properties of a vertex</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="last-mod-source-of-truth">
+ <span class="json-property-name">last-mod-source-of-truth:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="aai-node-type">
+ <span class="json-property-name">aai-node-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="aai-created-ts">
+ <span class="json-property-name">aai-created-ts:</span>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="aai-unique-key">
+ <span class="json-property-name">aai-unique-key:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="aai-last-mod-ts">
+ <span class="json-property-name">aai-last-mod-ts:</span>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="source-of-truth">
+ <span class="json-property-name">source-of-truth:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="aai-uri">
+ <span class="json-property-name">aai-uri:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-response-list" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/response-list"></a>response-list:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Response container for the results of a named-query or model query</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="inventory-response-items">
+ <span class="json-property-name">inventory-response-items:</span>
+ <span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/inventory-response-items">inventory-response-items</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-result-data" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/result-data"></a>result-data:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="resource-type">
+ <span class="json-property-name">resource-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>The specific type of node in the A&AI graph</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-link">
+ <span class="json-property-name">resource-link:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>The URL to the specific resource</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-route-table-reference" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/route-table-reference"></a>route-table-reference:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Openstack route table reference.</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="route-table-reference-id">
+ <span class="json-property-name">route-table-reference-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Route Table Reference id, UUID assigned to this instance.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="route-table-reference-fqdn">
+ <span class="json-property-name">route-table-reference-fqdn:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>FQDN entry in the route table.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Concurrency value</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-route-table-references" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/route-table-references"></a>route-table-references:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Collection of openstack route table references</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="route-table-reference">
+ <span class="json-property-name">route-table-reference:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/route-table-reference">route-table-reference</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-route-target" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/route-target"></a>route-target:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Route target information</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="global-route-target">
+ <span class="json-property-name">global-route-target:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Number used to identify an RT, globally unique in the network</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="route-target-role">
+ <span class="json-property-name">route-target-role:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Role assigned to this route target</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-route-targets" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/route-targets"></a>route-targets:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Collection of route target information</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="route-target">
+ <span class="json-property-name">route-target:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/route-target">route-target</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-routing-instance" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/routing-instance"></a>routing-instance:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)</li>
+<li>FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)</li>
+<li>ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="routing-instance-id">
+ <span class="json-property-name">routing-instance-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Unique id of routing instance</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="rpm-owner">
+ <span class="json-property-name">rpm-owner:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>rpm owner</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="site-pairs">
+ <span class="json-property-name">site-pairs:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/site-pair">site-pair</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-routing-instances" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/routing-instances"></a>routing-instances:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>set of probes related to generic-vnf routing instance</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="routing-instance">
+ <span class="json-property-name">routing-instance:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/routing-instance">routing-instance</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-sdn-zone-response" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/sdn-zone-response"></a>sdn-zone-response:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="oam-networks">
+ <span class="json-property-name">oam-networks:</span>
+ <span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/oam-networks">oam-networks</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="az-and-dvs-switches">
+ <span class="json-property-name">az-and-dvs-switches:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/az-and-dvs-switches">az-and-dvs-switches</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-search" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/search"></a>search:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="edge-tag-query-result">
+ <span class="json-property-name">edge-tag-query-result:</span>
+ <span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/edge-tag-query-result">edge-tag-query-result</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="edge-tag-query-request">
+ <span class="json-property-name">edge-tag-query-request:</span>
+ <span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/edge-tag-query-request">edge-tag-query-request</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="search-results">
+ <span class="json-property-name">search-results:</span>
+ <span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/search-results">search-results</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="sdn-zone-response">
+ <span class="json-property-name">sdn-zone-response:</span>
+ <span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/sdn-zone-response">sdn-zone-response</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-search-results" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/search-results"></a>search-results:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="result-data">
+ <span class="json-property-name">result-data:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/result-data">result-data</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-secondary-filt" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/secondary-filt"></a>secondary-filt:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>SecondaryFilt for performing a named-query or model query</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-secondary-filter" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/secondary-filter"></a>secondary-filter:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="property-name">
+ <span class="json-property-name">property-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="filter-type">
+ <span class="json-property-name">filter-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="property-value">
+ <span class="json-property-name">property-value:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-secondary-filts" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/secondary-filts"></a>secondary-filts:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>SecondaryFilts for performing a named-query or model query</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="secondary-filt">
+ <span class="json-property-name">secondary-filt:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/secondary-filt">secondary-filt</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-segmentation-assignment" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/segmentation-assignment"></a>segmentation-assignment:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Openstack segmentation assignment.</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="segmentation-id">
+ <span class="json-property-name">segmentation-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Route Table Reference id, UUID assigned to this instance.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Concurrency value</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-segmentation-assignments" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/segmentation-assignments"></a>segmentation-assignments:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Collection of openstack segmentation assignments</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="segmentation-assignment">
+ <span class="json-property-name">segmentation-assignment:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/segmentation-assignment">segmentation-assignment</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-service" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/service"></a>service:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services.</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="service-id">
+ <span class="json-property-name">service-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>This gets defined by others to provide a unique ID for the service, we accept what is sent.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="service-description">
+ <span class="json-property-name">service-description:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Description of the service</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="service-selflink">
+ <span class="json-property-name">service-selflink:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>URL to endpoint where AAI can get more details</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="service-version">
+ <span class="json-property-name">service-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>service version</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-service-capabilities" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/service-capabilities"></a>service-capabilities:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Collection of service capabilities.</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="service-capability">
+ <span class="json-property-name">service-capability:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/service-capability">service-capability</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-service-capability" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/service-capability"></a>service-capability:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this.</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)</li>
+<li>FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)</li>
+<li>SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="service-type">
+ <span class="json-property-name">service-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>This gets defined by others to provide a unique ID for the service, we accept what is sent.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vnf-type">
+ <span class="json-property-name">vnf-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>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.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-service-design-and-creation" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/service-design-and-creation"></a>service-design-and-creation:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Namespace for objects managed by ASDC</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="vnf-images">
+ <span class="json-property-name">vnf-images:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/vnf-image">vnf-image</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="services">
+ <span class="json-property-name">services:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/service">service</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="service-capabilities">
+ <span class="json-property-name">service-capabilities:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/service-capability">service-capability</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="models">
+ <span class="json-property-name">models:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/model">model</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="named-queries">
+ <span class="json-property-name">named-queries:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/named-query">named-query</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-service-instance" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/service-instance"></a>service-instance:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Instance of a service</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)</li>
+<li>TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)</li>
+<li>TO owning-entity( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)</li>
+<li>TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)</li>
+<li>TO configuration( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)</li>
+<li>TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)</li>
+<li>TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)</li>
+<li>TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY)</li>
+<li>TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)</li>
+<li>TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)</li>
+<li>TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)</li>
+<li>TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)</li>
+<li>TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)</li>
+<li>TO zone( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)</li>
+<li>TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)</li>
+<li>TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)</li>
+<li>TO model-ver( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One)</li>
+<li>FROM project( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)</li>
+<li>FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)</li>
+<li>FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)</li>
+<li>FROM forwarding-path( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)</li>
+<li>FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)</li>
+<li>SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM,FORWARDING-PATH</li>
+<li>SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="service-instance-id">
+ <span class="json-property-name">service-instance-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Uniquely identifies this instance of a service</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="service-instance-name">
+ <span class="json-property-name">service-instance-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>This field will store a name assigned to the service-instance.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="service-type">
+ <span class="json-property-name">service-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>String capturing type of service.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="service-role">
+ <span class="json-property-name">service-role:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>String capturing the service role.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="environment-context">
+ <span class="json-property-name">environment-context:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>This field will store the environment context assigned to the service-instance.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="workload-context">
+ <span class="json-property-name">workload-context:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>This field will store the workload context assigned to the service-instance.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="created-at">
+ <span class="json-property-name">created-at:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>create time of Network Service.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="updated-at">
+ <span class="json-property-name">updated-at:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>last update of Network Service.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="description">
+ <span class="json-property-name">description:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>short description for service-instance.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="model-invariant-id">
+ <span class="json-property-name">model-invariant-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>the ASDC model id for this resource or service model.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="model-version-id">
+ <span class="json-property-name">model-version-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>the ASDC model version for this resource or service model.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="persona-model-version">
+ <span class="json-property-name">persona-model-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>the ASDC model version for this resource or service model.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="widget-model-id">
+ <span class="json-property-name">widget-model-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="widget-model-version">
+ <span class="json-property-name">widget-model-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="bandwidth-total">
+ <span class="json-property-name">bandwidth-total:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Indicates the total bandwidth to be used for this service.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="bandwidth-up-wan1">
+ <span class="json-property-name">bandwidth-up-wan1:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="bandwidth-down-wan1">
+ <span class="json-property-name">bandwidth-down-wan1:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="bandwidth-up-wan2">
+ <span class="json-property-name">bandwidth-up-wan2:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="bandwidth-down-wan2">
+ <span class="json-property-name">bandwidth-down-wan2:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vhn-portal-url">
+ <span class="json-property-name">vhn-portal-url:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>URL customers will use to access the vHN Portal.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="service-instance-location-id">
+ <span class="json-property-name">service-instance-location-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>An identifier that customers assign to the location where this service is being used.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="selflink">
+ <span class="json-property-name">selflink:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Path to the controller object.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="orchestration-status">
+ <span class="json-property-name">orchestration-status:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Orchestration status of this service.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="metadata">
+ <span class="json-property-name">metadata:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/metadatum">metadatum</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="allotted-resources">
+ <span class="json-property-name">allotted-resources:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/allotted-resource">allotted-resource</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-service-instances" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/service-instances"></a>service-instances:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Collection of service instances</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="service-instance">
+ <span class="json-property-name">service-instance:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/service-instance">service-instance</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-service-subscription" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/service-subscription"></a>service-subscription:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Object that group service instances.</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)</li>
+<li>TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)</li>
+<li>FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)</li>
+<li>SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="service-type">
+ <span class="json-property-name">service-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Value defined by orchestration to identify this service across ECOMP.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="temp-ub-sub-account-id">
+ <span class="json-property-name">temp-ub-sub-account-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>This property will be deleted from A&AI in the near future. Only stop gap solution.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="service-instances">
+ <span class="json-property-name">service-instances:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/service-instance">service-instance</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-service-subscriptions" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/service-subscriptions"></a>service-subscriptions:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Collection of objects that group service instances.</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="service-subscription">
+ <span class="json-property-name">service-subscription:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/service-subscription">service-subscription</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-services" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/services"></a>services:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Collection of service model definitions. Likely to be deprecated in favor of models from ASDC.</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="service">
+ <span class="json-property-name">service:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/service">service</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-site-pair" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/site-pair"></a>site-pair:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)</li>
+<li>FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)</li>
+<li>SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="site-pair-id">
+ <span class="json-property-name">site-pair-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>unique identifier of probe</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="source-ip">
+ <span class="json-property-name">source-ip:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Prefix address</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="destination-ip">
+ <span class="json-property-name">destination-ip:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Prefix address</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="ip-version">
+ <span class="json-property-name">ip-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>ip version, v4, v6</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="destination-hostname">
+ <span class="json-property-name">destination-hostname:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Hostname of the destination equipment to which SLAs are measured against.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="destination-equip-type">
+ <span class="json-property-name">destination-equip-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>The type of destinatination equipment. Could be Router, UCPE, etc.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="classes-of-service">
+ <span class="json-property-name">classes-of-service:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/class-of-service">class-of-service</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-site-pair-set" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/site-pair-set"></a>site-pair-set:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Set of instances for probes used to measure service level agreements</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)</li>
+<li>FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)</li>
+<li>SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="site-pair-set-id">
+ <span class="json-property-name">site-pair-set-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Unique id of site pair set.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="routing-instances">
+ <span class="json-property-name">routing-instances:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/routing-instance">routing-instance</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-site-pair-sets" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/site-pair-sets"></a>site-pair-sets:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Collection of sets of instances for probes related to generic-vnf</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="site-pair-set">
+ <span class="json-property-name">site-pair-set:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/site-pair-set">site-pair-set</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-site-pairs" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/site-pairs"></a>site-pairs:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>probe within a set</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="site-pair">
+ <span class="json-property-name">site-pair:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/site-pair">site-pair</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-snapshot" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/snapshot"></a>snapshot:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Openstack snapshot</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)</li>
+<li>FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="snapshot-id">
+ <span class="json-property-name">snapshot-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Snapshot id, this is the key UUID assoc associated in glance with the snapshots.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="snapshot-name">
+ <span class="json-property-name">snapshot-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Snapshot name</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="snapshot-architecture">
+ <span class="json-property-name">snapshot-architecture:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Operating system architecture</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="snapshot-os-distro">
+ <span class="json-property-name">snapshot-os-distro:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>The common name of the operating system distribution in lowercase</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="snapshot-os-version">
+ <span class="json-property-name">snapshot-os-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>The operating system version as specified by the distributor.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="application">
+ <span class="json-property-name">application:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>The application that the image instantiates.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="application-vendor">
+ <span class="json-property-name">application-vendor:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>The vendor of the application.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="application-version">
+ <span class="json-property-name">application-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>The version of the application.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="snapshot-selflink">
+ <span class="json-property-name">snapshot-selflink:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>URL to endpoint where AAI can get more details</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="prev-snapshot-id">
+ <span class="json-property-name">prev-snapshot-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>This field contains the UUID of the previous snapshot (if any).</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-snapshots" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/snapshots"></a>snapshots:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Collection of openstack snapshots</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="snapshot">
+ <span class="json-property-name">snapshot:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/snapshot">snapshot</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-sriov-pf" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/sriov-pf"></a>sriov-pf:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>SR-IOV Physical Function</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)</li>
+<li>FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="pf-pci-id">
+ <span class="json-property-name">pf-pci-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Identifier for the sriov-pf</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-sriov-pfs" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/sriov-pfs"></a>sriov-pfs:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Collection of SR-IOV Physical Functions.</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="sriov-pf">
+ <span class="json-property-name">sriov-pf:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/sriov-pf">sriov-pf</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-sriov-vf" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/sriov-vf"></a>sriov-vf:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>SR-IOV Virtual Function (not to be confused with virtual network function)</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)</li>
+<li>TO sriov-pf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="pci-id">
+ <span class="json-property-name">pci-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>PCI ID used to identify the sriov-vf</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vf-vlan-filter">
+ <span class="json-property-name">vf-vlan-filter:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vf-mac-filter">
+ <span class="json-property-name">vf-mac-filter:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vf-vlan-strip">
+ <span class="json-property-name">vf-vlan-strip:</span>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vf-vlan-anti-spoof-check">
+ <span class="json-property-name">vf-vlan-anti-spoof-check:</span>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>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.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vf-mac-anti-spoof-check">
+ <span class="json-property-name">vf-mac-anti-spoof-check:</span>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>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.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vf-mirrors">
+ <span class="json-property-name">vf-mirrors:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vf-broadcast-allow">
+ <span class="json-property-name">vf-broadcast-allow:</span>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vf-unknown-multicast-allow">
+ <span class="json-property-name">vf-unknown-multicast-allow:</span>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vf-unknown-unicast-allow">
+ <span class="json-property-name">vf-unknown-unicast-allow:</span>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vf-insert-stag">
+ <span class="json-property-name">vf-insert-stag:</span>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>This option, if set to true, instructs to insert outer tag after traffic comes out of VM.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vf-link-status">
+ <span class="json-property-name">vf-link-status:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>This option is used to set the link status. Valid values as of 1607 are on, off, and auto.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="neutron-network-id">
+ <span class="json-property-name">neutron-network-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Neutron network id of the interface</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-sriov-vfs" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/sriov-vfs"></a>sriov-vfs:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Collection of SR-IOV Virtual Functions.</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="sriov-vf">
+ <span class="json-property-name">sriov-vf:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/sriov-vf">sriov-vf</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-start-node-filter" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/start-node-filter"></a>start-node-filter:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="property-name">
+ <span class="json-property-name">property-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="property-value">
+ <span class="json-property-name">property-value:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-subnet" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/subnet"></a>subnet:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)</li>
+<li>FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)</li>
+<li>FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)</li>
+<li>FROM host-route( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)</li>
+<li>FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)</li>
+<li>FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)</li>
+<li>SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST</li>
+<li>SUBNET is DELETED when these are DELETED HOST-ROUTE</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="subnet-id">
+ <span class="json-property-name">subnet-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Subnet ID, should be UUID.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="subnet-name">
+ <span class="json-property-name">subnet-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Name associated with the subnet.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="neutron-subnet-id">
+ <span class="json-property-name">neutron-subnet-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Neutron id of this subnet</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="gateway-address">
+ <span class="json-property-name">gateway-address:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>gateway ip address</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="network-start-address">
+ <span class="json-property-name">network-start-address:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>network start address</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="cidr-mask">
+ <span class="json-property-name">cidr-mask:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>cidr mask</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="ip-version">
+ <span class="json-property-name">ip-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>ip version</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="orchestration-status">
+ <span class="json-property-name">orchestration-status:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Orchestration status of this VNF, mastered by MSO</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="dhcp-enabled">
+ <span class="json-property-name">dhcp-enabled:</span>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="dhcp-start">
+ <span class="json-property-name">dhcp-start:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>the start address reserved for use by dhcp</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="dhcp-end">
+ <span class="json-property-name">dhcp-end:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>the last address reserved for use by dhcp</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="subnet-role">
+ <span class="json-property-name">subnet-role:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>role of the subnet, referenced when assigning IPs</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="ip-assignment-direction">
+ <span class="json-property-name">ip-assignment-direction:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>ip address assignment direction of the subnet</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="subnet-sequence">
+ <span class="json-property-name">subnet-sequence:</span>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>sequence of the subnet</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="host-routes">
+ <span class="json-property-name">host-routes:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/host-route">host-route</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-subnets" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/subnets"></a>subnets:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="subnet">
+ <span class="json-property-name">subnet:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/subnet">subnet</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-tagged-inventory-item-list" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/tagged-inventory-item-list"></a>tagged-inventory-item-list:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="inventory-item">
+ <span class="json-property-name">inventory-item:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/inventory-item">inventory-item</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-tenant" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/tenant"></a>tenant:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Openstack tenant</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)</li>
+<li>TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)</li>
+<li>TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)</li>
+<li>TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)</li>
+<li>FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)</li>
+<li>FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)</li>
+<li>TENANT cannot be deleted if linked to VSERVER</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="tenant-id">
+ <span class="json-property-name">tenant-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Unique id relative to the cloud-region.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="tenant-name">
+ <span class="json-property-name">tenant-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Readable name of tenant</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="tenant-context">
+ <span class="json-property-name">tenant-context:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>This field will store the tenant context.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vservers">
+ <span class="json-property-name">vservers:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/vserver">vserver</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-tenants" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/tenants"></a>tenants:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Collection of openstack tenants.</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="tenant">
+ <span class="json-property-name">tenant:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/tenant">tenant</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-tunnel-xconnect" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/tunnel-xconnect"></a>tunnel-xconnect:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="id">
+ <span class="json-property-name">id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Allotted Resource id UUID assigned to this instance.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="bandwidth-up-wan1">
+ <span class="json-property-name">bandwidth-up-wan1:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>The WAN uplink bandwidth for WAN1</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="bandwidth-down-wan1">
+ <span class="json-property-name">bandwidth-down-wan1:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>The WAN downlink bandwidth for WAN1</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="bandwidth-up-wan2">
+ <span class="json-property-name">bandwidth-up-wan2:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>The WAN uplink bandwidth for WAN2</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="bandwidth-down-wan2">
+ <span class="json-property-name">bandwidth-down-wan2:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>The WAN downlink bandwidth for WAN2</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Concurrency value</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-tunnel-xconnects" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/tunnel-xconnects"></a>tunnel-xconnects:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>This object is used to store the specific tunnel cross connect aspects of an allotted resource</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="tunnel-xconnect">
+ <span class="json-property-name">tunnel-xconnect:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/tunnel-xconnect">tunnel-xconnect</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-update" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/update"></a>update:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team.</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="update-node-type">
+ <span class="json-property-name">update-node-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="update-node-uri">
+ <span class="json-property-name">update-node-uri:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="update-node-key">
+ <span class="json-property-name">update-node-key:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/update-node-key">update-node-key</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="action">
+ <span class="json-property-name">action:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/action">action</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-update-node-key" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/update-node-key"></a>update-node-key:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="key-name">
+ <span class="json-property-name">key-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="key-value">
+ <span class="json-property-name">key-value:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-vce" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/vce"></a>vce:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated.</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)</li>
+<li>TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)</li>
+<li>TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY)</li>
+<li>FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)</li>
+<li>FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)</li>
+<li>FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)</li>
+<li>FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)</li>
+<li>VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="vnf-id">
+ <span class="json-property-name">vnf-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vnf-name">
+ <span class="json-property-name">vnf-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Name of VNF.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vnf-name2">
+ <span class="json-property-name">vnf-name2:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Alternate name of VNF.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vnf-type">
+ <span class="json-property-name">vnf-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>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.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="service-id">
+ <span class="json-property-name">service-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="regional-resource-zone">
+ <span class="json-property-name">regional-resource-zone:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Regional way of organizing pservers, source of truth should define values</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="prov-status">
+ <span class="json-property-name">prov-status:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="operational-status">
+ <span class="json-property-name">operational-status:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Indicator for whether the resource is considered operational</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="license-key">
+ <span class="json-property-name">license-key:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>OBSOLETE - do not use</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="equipment-role">
+ <span class="json-property-name">equipment-role:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Network role being played by this VNF</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="orchestration-status">
+ <span class="json-property-name">orchestration-status:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Orchestration status of this VNF, mastered by MSO</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="heat-stack-id">
+ <span class="json-property-name">heat-stack-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Heat stack id corresponding to this instance, managed by MSO</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="mso-catalog-key">
+ <span class="json-property-name">mso-catalog-key:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Corresponds to the SDN-C catalog id used to configure this VCE</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vpe-id">
+ <span class="json-property-name">vpe-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Unique ID of VPE connected to this VCE.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="v6-vce-wan-address">
+ <span class="json-property-name">v6-vce-wan-address:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Valid v6 IP address for the WAN Link on this router. Implied length of /64.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="ipv4-oam-address">
+ <span class="json-property-name">ipv4-oam-address:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="ipv4-loopback0-address">
+ <span class="json-property-name">ipv4-loopback0-address:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Loopback0 address</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="entitlement-resource-uuid">
+ <span class="json-property-name">entitlement-resource-uuid:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>OBSOLETE - see child relationships</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="port-groups">
+ <span class="json-property-name">port-groups:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/port-group">port-group</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="licenses">
+ <span class="json-property-name">licenses:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/license">license</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="entitlements">
+ <span class="json-property-name">entitlements:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/entitlement">entitlement</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-vces" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/vces"></a>vces:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated.</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="vce">
+ <span class="json-property-name">vce:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/vce">vce</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-vf-module" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/vf-module"></a>vf-module:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>a deployment unit of VNFCs</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)</li>
+<li>TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)</li>
+<li>TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)</li>
+<li>TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)</li>
+<li>TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)</li>
+<li>TO model-ver( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One)</li>
+<li>VF-MODULE cannot be deleted if linked to VNFC</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="vf-module-id">
+ <span class="json-property-name">vf-module-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Unique ID of vf-module.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vf-module-name">
+ <span class="json-property-name">vf-module-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Name of vf-module</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="heat-stack-id">
+ <span class="json-property-name">heat-stack-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Heat stack id corresponding to this instance.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="orchestration-status">
+ <span class="json-property-name">orchestration-status:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>orchestration status of this vf-module, mastered by MSO</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="is-base-vf-module">
+ <span class="json-property-name">is-base-vf-module:</span>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="model-invariant-id">
+ <span class="json-property-name">model-invariant-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>the ASDC model id for this resource or service model.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="model-version-id">
+ <span class="json-property-name">model-version-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>the ASDC model version for this resource or service model.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="persona-model-version">
+ <span class="json-property-name">persona-model-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>the ASDC model version for this resource or service model.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="model-customization-id">
+ <span class="json-property-name">model-customization-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>captures the id of all the configuration used to customize the resource for the service.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="widget-model-id">
+ <span class="json-property-name">widget-model-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>the ASDC data dictionary widget model. This maps directly to the A&AI widget.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="widget-model-version">
+ <span class="json-property-name">widget-model-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="contrail-service-instance-fqdn">
+ <span class="json-property-name">contrail-service-instance-fqdn:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>the Contrail unique ID for a service-instance</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="module-index">
+ <span class="json-property-name">module-index:</span>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>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</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="selflink">
+ <span class="json-property-name">selflink:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Path to the controller object.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-vf-modules" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/vf-modules"></a>vf-modules:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Collection of vf-modules, a deployment unit of VNFCs</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="vf-module">
+ <span class="json-property-name">vf-module:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/vf-module">vf-module</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-vig-server" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/vig-server"></a>vig-server:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="vig-address-type">
+ <span class="json-property-name">vig-address-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>indicates whether the VIG is for AVPN or INTERNET</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="ipaddress-v4-vig">
+ <span class="json-property-name">ipaddress-v4-vig:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>v4 IP of the vig server</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="ipaddress-v6-vig">
+ <span class="json-property-name">ipaddress-v6-vig:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>v6 IP of the vig server</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-vig-servers" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/vig-servers"></a>vig-servers:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="vig-server">
+ <span class="json-property-name">vig-server:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/vig-server">vig-server</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-vip-ipv4-address-list" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/vip-ipv4-address-list"></a>vip-ipv4-address-list:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>IPv4 Address Range</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)</li>
+<li>TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)</li>
+<li>TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)</li>
+<li>FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="vip-ipv4-address">
+ <span class="json-property-name">vip-ipv4-address:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>IP address</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vip-ipv4-prefix-length">
+ <span class="json-property-name">vip-ipv4-prefix-length:</span>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Prefix length, 32 for single address</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vlan-id-inner">
+ <span class="json-property-name">vlan-id-inner:</span>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Inner VLAN tag</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vlan-id-outer">
+ <span class="json-property-name">vlan-id-outer:</span>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Outer VLAN tag</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="is-floating">
+ <span class="json-property-name">is-floating:</span>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Indicator of fixed or floating address</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="neutron-network-id">
+ <span class="json-property-name">neutron-network-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Neutron network id of the interface that address belongs to</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="neutron-subnet-id">
+ <span class="json-property-name">neutron-subnet-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Neutron id of subnet that address belongs to</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-vip-ipv6-address-list" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/vip-ipv6-address-list"></a>vip-ipv6-address-list:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>IPv6 Address Range</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)</li>
+<li>TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)</li>
+<li>TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)</li>
+<li>FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="vip-ipv6-address">
+ <span class="json-property-name">vip-ipv6-address:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>IP address</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vip-ipv6-prefix-length">
+ <span class="json-property-name">vip-ipv6-prefix-length:</span>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Prefix length, 128 for single address</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vlan-id-inner">
+ <span class="json-property-name">vlan-id-inner:</span>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Inner VLAN tag</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vlan-id-outer">
+ <span class="json-property-name">vlan-id-outer:</span>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Outer VLAN tag</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="is-floating">
+ <span class="json-property-name">is-floating:</span>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Indicator of fixed or floating address</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="neutron-network-id">
+ <span class="json-property-name">neutron-network-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Neutron network id of the interface that address belongs to</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="neutron-subnet-id">
+ <span class="json-property-name">neutron-subnet-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Neutron id of subnet that address belongs to</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-virtual-data-center" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/virtual-data-center"></a>virtual-data-center:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Virtual organization of cloud infrastructure elements in a data center context</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)</li>
+<li>FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)</li>
+<li>FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="vdc-id">
+ <span class="json-property-name">vdc-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Unique ID of the vdc</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vdc-name">
+ <span class="json-property-name">vdc-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Name of the virtual data center</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-virtual-data-centers" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/virtual-data-centers"></a>virtual-data-centers:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Virtual organization of cloud infrastructure elements in a data center context</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="virtual-data-center">
+ <span class="json-property-name">virtual-data-center:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/virtual-data-center">virtual-data-center</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-vlan" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/vlan"></a>vlan:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Definition of vlan</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)</li>
+<li>TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)</li>
+<li>TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)</li>
+<li>FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)</li>
+<li>FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)</li>
+<li>FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)</li>
+<li>FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)</li>
+<li>VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST</li>
+<li>VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="vlan-interface">
+ <span class="json-property-name">vlan-interface:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>String that identifies the interface</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vlan-id-inner">
+ <span class="json-property-name">vlan-id-inner:</span>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Inner VLAN tag</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vlan-id-outer">
+ <span class="json-property-name">vlan-id-outer:</span>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Outer VLAN tag</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="speed-value">
+ <span class="json-property-name">speed-value:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Captures the numeric part of the speed</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="speed-units">
+ <span class="json-property-name">speed-units:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Captures the units corresponding to the speed</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vlan-description">
+ <span class="json-property-name">vlan-description:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used to describe (the service associated with) the vlan</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="backdoor-connection">
+ <span class="json-property-name">backdoor-connection:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Whether customer is going to use this VLAN for backdoor connection to another customer premise device.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vpn-key">
+ <span class="json-property-name">vpn-key:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>This indicates the customers VPN ID associated with this vlan</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="orchestration-status">
+ <span class="json-property-name">orchestration-status:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="in-maint">
+ <span class="json-property-name">in-maint:</span>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="prov-status">
+ <span class="json-property-name">prov-status:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV].</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="is-ip-unnumbered">
+ <span class="json-property-name">is-ip-unnumbered:</span>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="l3-interface-ipv4-address-list">
+ <span class="json-property-name">l3-interface-ipv4-address-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">l3-interface-ipv4-address-list</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="l3-interface-ipv6-address-list">
+ <span class="json-property-name">l3-interface-ipv6-address-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">l3-interface-ipv6-address-list</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-vlans" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/vlans"></a>vlans:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="vlan">
+ <span class="json-property-name">vlan:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/vlan">vlan</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-vnf" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/vnf"></a>vnf:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Abstract vnf class</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="vnf-id">
+ <span class="json-property-name">vnf-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Unique id of VNF. This is unique across the graph.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-vnf-image" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/vnf-image"></a>vnf-image:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge.</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)</li>
+<li>VNF-IMAGE cannot be deleted if linked to GENERIC-VNF</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="vnf-image-uuid">
+ <span class="json-property-name">vnf-image-uuid:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Unique ID of this asset</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="application">
+ <span class="json-property-name">application:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>The application that the image instantiates.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="application-vendor">
+ <span class="json-property-name">application-vendor:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>The vendor of the application.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="application-version">
+ <span class="json-property-name">application-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>The version of the application.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="selflink">
+ <span class="json-property-name">selflink:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>URL to endpoint where AAI can get more details</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-vnf-images" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/vnf-images"></a>vnf-images:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge.</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="vnf-image">
+ <span class="json-property-name">vnf-image:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/vnf-image">vnf-image</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-vnfc" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/vnfc"></a>vnfc:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)</li>
+<li>TO instance-group( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)</li>
+<li>TO vip-ipv4-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)</li>
+<li>TO vip-ipv6-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)</li>
+<li>TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)</li>
+<li>FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)</li>
+<li>FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)</li>
+<li>FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)</li>
+<li>VNFC is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="vnfc-name">
+ <span class="json-property-name">vnfc-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Unique ID of vnfc.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="nfc-naming-code">
+ <span class="json-property-name">nfc-naming-code:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Short code that is used in naming instances of the item being modeled</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="nfc-function">
+ <span class="json-property-name">nfc-function:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="prov-status">
+ <span class="json-property-name">prov-status:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>prov status of this vnfc</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="orchestration-status">
+ <span class="json-property-name">orchestration-status:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Orchestration status of this VNF, mastered by APP-C</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="ipaddress-v4-oam-vip">
+ <span class="json-property-name">ipaddress-v4-oam-vip:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Oam V4 vip address of this vnfc</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="in-maint">
+ <span class="json-property-name">in-maint:</span>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="is-closed-loop-disabled">
+ <span class="json-property-name">is-closed-loop-disabled:</span>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="group-notation">
+ <span class="json-property-name">group-notation:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Group notation of VNFC</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="model-invariant-id">
+ <span class="json-property-name">model-invariant-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>the ASDC model id for this resource or service model.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="model-version-id">
+ <span class="json-property-name">model-version-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>the ASDC model version for this resource or service model.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="l3-interface-ipv4-address-list">
+ <span class="json-property-name">l3-interface-ipv4-address-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/l3-interface-ipv4-address-list">l3-interface-ipv4-address-list</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="l3-interface-ipv6-address-list">
+ <span class="json-property-name">l3-interface-ipv6-address-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/l3-interface-ipv6-address-list">l3-interface-ipv6-address-list</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-vnfcs" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/vnfcs"></a>vnfcs:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>virtual network components associated with a vserver from application controller.</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="vnfc">
+ <span class="json-property-name">vnfc:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/vnfc">vnfc</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-volume" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/volume"></a>volume:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Ephemeral Block storage volume.</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume)</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="volume-id">
+ <span class="json-property-name">volume-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Unique ID of block storage volume relative to the vserver.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="volume-selflink">
+ <span class="json-property-name">volume-selflink:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>URL to endpoint where AAI can get more details</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-volume-group" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/volume-group"></a>volume-group:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Persistent block-level storage.</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)</li>
+<li>TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)</li>
+<li>FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)</li>
+<li>FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)</li>
+<li>FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="volume-group-id">
+ <span class="json-property-name">volume-group-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Unique ID of volume-group.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="volume-group-name">
+ <span class="json-property-name">volume-group-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Name of the volume group.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="heat-stack-id">
+ <span class="json-property-name">heat-stack-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Heat stack id corresponding to this volume-group</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vnf-type">
+ <span class="json-property-name">vnf-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>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.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="orchestration-status">
+ <span class="json-property-name">orchestration-status:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Orchestration status of this volume-group</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="model-customization-id">
+ <span class="json-property-name">model-customization-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>captures the id of all the configuration used to customize the resource for the service.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vf-module-model-customization-id">
+ <span class="json-property-name">vf-module-model-customization-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>helps relate the volume group to the vf-module whose components will require the volume group</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-volume-groups" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/volume-groups"></a>volume-groups:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Collection of persistent block-level storage.</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="volume-group">
+ <span class="json-property-name">volume-group:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/volume-group">volume-group</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-volumes" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/volumes"></a>volumes:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Collection of ephemeral Block storage volumes.</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="volume">
+ <span class="json-property-name">volume:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/volume">volume</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-vpls-pe" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/vpls-pe"></a>vpls-pe:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>VPLS Provider Edge routers.</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)</li>
+<li>TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)</li>
+<li>FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)</li>
+<li>FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)</li>
+<li>VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="equipment-name">
+ <span class="json-property-name">equipment-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="prov-status">
+ <span class="json-property-name">prov-status:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Trigger for operational monitoring of this VNF by BAU Service Assurance systems.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="ipv4-oam-address">
+ <span class="json-property-name">ipv4-oam-address:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>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).</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="equipment-role">
+ <span class="json-property-name">equipment-role:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Client should send valid enumerated value, e.g., VPLS-PE.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vlan-id-outer">
+ <span class="json-property-name">vlan-id-outer:</span>
+ <span class="json-property-type">integer</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Temporary location for stag to get to VCE</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="p-interfaces">
+ <span class="json-property-name">p-interfaces:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/p-interface">p-interface</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="lag-interfaces">
+ <span class="json-property-name">lag-interfaces:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/lag-interface">lag-interface</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-vpls-pes" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/vpls-pes"></a>vpls-pes:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Collection of VPLS Provider Edge routers</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="vpls-pe">
+ <span class="json-property-name">vpls-pe:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/vpls-pe">vpls-pe</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-vpn-binding" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/vpn-binding"></a>vpn-binding:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>VPN binding</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY)</li>
+<li>FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)</li>
+<li>FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)</li>
+<li>FROM route-target( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)</li>
+<li>VPN-BINDING cannot be deleted if linked to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK</li>
+<li>VPN-BINDING is DELETED when these are DELETED ROUTE-TARGET</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="vpn-id">
+ <span class="json-property-name">vpn-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>VPN ID, globally unique within A&AI</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vpn-name">
+ <span class="json-property-name">vpn-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>VPN Name</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vpn-platform">
+ <span class="json-property-name">vpn-platform:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>the platform associated with the VPN example AVPN, Mobility</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vpn-type">
+ <span class="json-property-name">vpn-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Type of the vpn, should be taken from enumerated/valid values</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vpn-region">
+ <span class="json-property-name">vpn-region:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>region of customer vpn</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="customer-vpn-id">
+ <span class="json-property-name">customer-vpn-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>id for this customer vpn</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="route-distinguisher">
+ <span class="json-property-name">route-distinguisher:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="route-targets">
+ <span class="json-property-name">route-targets:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/route-target">route-target</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-vpn-bindings" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/vpn-bindings"></a>vpn-bindings:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="vpn-binding">
+ <span class="json-property-name">vpn-binding:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/vpn-binding">vpn-binding</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-vserver" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/vserver"></a>vserver:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Virtual Servers, aka virtual machine or VM.</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)</li>
+<li>TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)</li>
+<li>TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)</li>
+<li>TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)</li>
+<li>TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)</li>
+<li>TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY)</li>
+<li>FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)</li>
+<li>FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY)</li>
+<li>FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)</li>
+<li>FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)</li>
+<li>FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)</li>
+<li>VSERVER is DELETED when these are DELETED L-INTERFACE</li>
+<li>VSERVER deletion means associated objects of these types are also DELETED:VOLUME</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="vserver-id">
+ <span class="json-property-name">vserver-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Unique identifier for this vserver relative to its tenant</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vserver-name">
+ <span class="json-property-name">vserver-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Name of vserver</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vserver-name2">
+ <span class="json-property-name">vserver-name2:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Alternative name of vserver</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="prov-status">
+ <span class="json-property-name">prov-status:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Trigger for operational monitoring of this resource by Service Assurance systems.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="vserver-selflink">
+ <span class="json-property-name">vserver-selflink:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>URL to endpoint where AAI can get more details</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="in-maint">
+ <span class="json-property-name">in-maint:</span>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="is-closed-loop-disabled">
+ <span class="json-property-name">is-closed-loop-disabled:</span>
+ <span class="json-property-type">boolean</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Used for optimistic concurrency. Must be empty on create, valid on update and delete.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="volumes">
+ <span class="json-property-name">volumes:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/volume">volume</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ <dt data-property-name="l-interfaces">
+ <span class="json-property-name">l-interfaces:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/l-interface">l-interface</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-vservers" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/vservers"></a>vservers:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Collection of virtual Servers, aka virtual machines or VMs.</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="vserver">
+ <span class="json-property-name">vserver:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/vserver">vserver</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-zone" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/zone"></a>zone:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>A zone is a grouping of assets in a location homing to the same connections into the CBB</p>
+<h6 id="related-nodes">Related Nodes</h6>
+<ul>
+<li>TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)</li>
+<li>FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)</li>
+<li>FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)</li>
+<li>FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)</li>
+<li>FROM service-instance( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)</li></ul>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="zone-id">
+ <span class="json-property-name">zone-id:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Code assigned by AIC to the zone</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="zone-name">
+ <span class="json-property-name">zone-name:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>English name associated with the zone</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="design-type">
+ <span class="json-property-name">design-type:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Design of zone [Medium/Largeā€¦]</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="zone-context">
+ <span class="json-property-name">zone-context:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <span class="json-property-required"></span>
+ </dt>
+ <dd>
+ <p>Context of zone [production/test]</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="status">
+ <span class="json-property-name">status:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Status of a zone.</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="resource-version">
+ <span class="json-property-name">resource-version:</span>
+ <span class="json-property-type">string</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+ <p>Concurrency value</p>
+ <div class="json-inner-schema">
+
+ </div>
+ </dd>
+ <dt data-property-name="relationship-list">
+ <span class="json-property-name">relationship-list:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/relationship">relationship</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+ <div id="definition-zones" class="panel panel-definition">
+ <div class="panel-heading">
+ <h3 class="panel-title"><a name="/definitions/zones"></a>zones:
+ <span class="json-property-type"><span class="json-property-type">object</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </span>
+ </h3>
+ </div>
+ <div class="panel-body">
+ <section class="json-schema-description">
+ <p>Collection of zones</p>
+
+ </section>
+
+ <section class="json-schema-properties">
+ <dl>
+ <dt data-property-name="zone">
+ <span class="json-property-name">zone:</span>
+ <span class="json-property-type">object[]</span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ </dt>
+ <dd>
+
+ <div class="json-inner-schema">
+
+ <section class="json-schema-array-items">
+ <span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/zone">zone</a>
+ </span>
+ <span class="json-property-range" title="Value limits"></span>
+
+ <div class="json-inner-schema">
+
+ </div>
+ </section> </div>
+ </dd>
+ </dl>
+ </section>
+ </div>
+ </div>
+</div>
+</body>
+</html>
diff --git a/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v12.yaml b/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v12.yaml
index 22919ea2..b1d047e2 100644
--- a/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v12.yaml
+++ b/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v12.yaml
@@ -53540,7 +53540,7 @@ definitions:
$ref: "#/definitions/operational-environment"
cloud-region:
description: |
- cloud-region designates an installation of a cloud cluster or region or instantiation. In cloud, this could be an LCP or DCP. Cloud regions are uniquely identified by a composite key, cloud-owner + cloud-region-id. The format of the cloud-owner is vendor-cloudname
+ cloud-region designates an installation of a cloud cluster or region or instantiation.
###### Related Nodes
- TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many)
- TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
@@ -53593,6 +53593,12 @@ definitions:
description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
sriov-automation:
type: boolean
+ cloud-extra-info:
+ type: string
+ description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
+ cloud-epa-caps:
+ type: string
+ description: MultiVIM will discover and expose EPA capabilities.
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
@@ -53735,7 +53741,7 @@ definitions:
$ref: "#/definitions/complex"
configuration:
description: |
- Generic configuration object.
+ Port Mirror Configuration.
###### Related Nodes
- TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
- TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
@@ -53754,6 +53760,10 @@ definitions:
- configuration-id
- configuration-type
- configuration-sub-type
+ - orchestration-status
+ - operational-status
+ - configuration-selflink
+ - model-customization-id
properties:
configuration-id:
type: string
@@ -56607,6 +56617,9 @@ definitions:
prov-status:
type: string
description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ mac-addresss:
+ type: string
+ description: MAC Address of the p-interface.
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
@@ -59036,7 +59049,7 @@ patchDefinitions:
$ref: "#/patchDefinitions/operational-environment"
cloud-region:
description: |
- cloud-region designates an installation of a cloud cluster or region or instantiation. In cloud, this could be an LCP or DCP. Cloud regions are uniquely identified by a composite key, cloud-owner + cloud-region-id. The format of the cloud-owner is vendor-cloudname
+ cloud-region designates an installation of a cloud cluster or region or instantiation.
###### Related Nodes
- TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many)
- TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
@@ -59089,6 +59102,12 @@ patchDefinitions:
description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
sriov-automation:
type: boolean
+ cloud-extra-info:
+ type: string
+ description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
+ cloud-epa-caps:
+ type: string
+ description: MultiVIM will discover and expose EPA capabilities.
cloud-regions:
properties:
cloud-region:
@@ -59144,7 +59163,7 @@ patchDefinitions:
$ref: "#/patchDefinitions/complex"
configuration:
description: |
- Generic configuration object.
+ Port Mirror Configuration.
###### Related Nodes
- TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
- TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
@@ -59163,6 +59182,10 @@ patchDefinitions:
- configuration-id
- configuration-type
- configuration-sub-type
+ - orchestration-status
+ - operational-status
+ - configuration-selflink
+ - model-customization-id
properties:
configuration-id:
type: string
@@ -61314,6 +61337,9 @@ patchDefinitions:
prov-status:
type: string
description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ mac-addresss:
+ type: string
+ description: MAC Address of the p-interface.
p-interfaces:
description: |
Collection of physical interfaces.
@@ -63264,7 +63290,7 @@ getDefinitions:
$ref: "#/getDefinitions/operational-environment"
cloud-region:
description: |
- cloud-region designates an installation of a cloud cluster or region or instantiation. In cloud, this could be an LCP or DCP. Cloud regions are uniquely identified by a composite key, cloud-owner + cloud-region-id. The format of the cloud-owner is vendor-cloudname
+ cloud-region designates an installation of a cloud cluster or region or instantiation.
###### Related Nodes
- TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many)
- TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
@@ -63317,6 +63343,12 @@ getDefinitions:
description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
sriov-automation:
type: boolean
+ cloud-extra-info:
+ type: string
+ description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
+ cloud-epa-caps:
+ type: string
+ description: MultiVIM will discover and expose EPA capabilities.
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
@@ -63459,7 +63491,7 @@ getDefinitions:
$ref: "#/getDefinitions/complex"
configuration:
description: |
- Generic configuration object.
+ Port Mirror Configuration.
###### Related Nodes
- TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
- TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
@@ -63478,6 +63510,10 @@ getDefinitions:
- configuration-id
- configuration-type
- configuration-sub-type
+ - orchestration-status
+ - operational-status
+ - configuration-selflink
+ - model-customization-id
properties:
configuration-id:
type: string
@@ -66331,6 +66367,9 @@ getDefinitions:
prov-status:
type: string
description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ mac-addresss:
+ type: string
+ description: MAC Address of the p-interface.
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
diff --git a/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v13.yaml b/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v13.yaml
new file mode 100644
index 00000000..91ae2515
--- /dev/null
+++ b/aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v13.yaml
@@ -0,0 +1,68602 @@
+swagger: "2.0"
+info:
+ description: |
+
+ [Differences versus the previous schema version](apidocs/aai_swagger_v13.diff)
+
+ Copyright &copy; 2017 AT&amp;T Intellectual Property. All rights reserved.
+
+ Licensed under the Creative Commons License, Attribution 4.0 Intl. (the &quot;License&quot;); 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/)
+
+ Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an &quot;AS IS&quot; 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&amp;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.
+ version: "v13"
+ title: Active and Available Inventory REST API
+ license:
+ name: Apache 2.0
+ url: http://www.apache.org/licenses/LICENSE-2.0.html
+ contact:
+ name:
+ url:
+ email:
+host:
+basePath: /aai/v13
+schemes:
+ - https
+paths:
+ /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}/relationship-list/relationship:
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPoolRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: physical-location-id
+ in: path
+ description: Unique identifier for physical location, e.g., CLLI
+ required: true
+ type: string
+ example: __PHYSICAL-LOCATION-ID__
+ - name: target-pe
+ in: path
+ description: The Target provider edge router
+ required: true
+ type: string
+ example: __TARGET-PE__
+ - name: availability-zone-name
+ in: path
+ description: Name of the availability zone
+ required: true
+ type: string
+ example: __AVAILABILITY-ZONE-NAME__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructureComplexesComplexCtagPoolsCtagPoolRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: physical-location-id
+ in: path
+ description: Unique identifier for physical location, e.g., CLLI
+ required: true
+ type: string
+ example: __PHYSICAL-LOCATION-ID__
+ - name: target-pe
+ in: path
+ description: The Target provider edge router
+ required: true
+ type: string
+ example: __TARGET-PE__
+ - name: availability-zone-name
+ in: path
+ description: Name of the availability zone
+ required: true
+ type: string
+ example: __AVAILABILITY-ZONE-NAME__
+ /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns ctag-pool
+ description: returns ctag-pool
+ operationId: getCloudInfrastructureComplexesComplexCtagPoolsCtagPool
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/ctag-pool"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: physical-location-id
+ in: path
+ description: Unique identifier for physical location, e.g., CLLI
+ required: true
+ type: string
+ example: __PHYSICAL-LOCATION-ID__
+ - name: target-pe
+ in: path
+ description: The Target provider edge router
+ required: true
+ type: string
+ example: __TARGET-PE__
+ - name: availability-zone-name
+ in: path
+ description: Name of the availability zone
+ required: true
+ type: string
+ example: __AVAILABILITY-ZONE-NAME__
+ - name: data-center-code
+ in: query
+ description: Data center code which can be an alternate way to identify a complex
+ required: false
+ type: string
+ - name: complex-name
+ in: query
+ description: Gamma complex name for LCP instance.
+ required: false
+ type: string
+ - name: identity-url
+ in: query
+ description: URL of the keystone identity service
+ required: false
+ type: string
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing ctag-pool
+ description: |
+ Create or update an existing ctag-pool.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPool
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: physical-location-id
+ in: path
+ description: Unique identifier for physical location, e.g., CLLI
+ required: true
+ type: string
+ example: __PHYSICAL-LOCATION-ID__
+ - name: target-pe
+ in: path
+ description: The Target provider edge router
+ required: true
+ type: string
+ example: __TARGET-PE__
+ - name: availability-zone-name
+ in: path
+ description: Name of the availability zone
+ required: true
+ type: string
+ example: __AVAILABILITY-ZONE-NAME__
+ - name: body
+ in: body
+ description: ctag-pool object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json)
+ required: true
+ schema:
+ $ref: "#/definitions/ctag-pool"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing ctag-pool
+ description: |
+ Update an existing ctag-pool
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPool
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: physical-location-id
+ in: path
+ description: Unique identifier for physical location, e.g., CLLI
+ required: true
+ type: string
+ example: __PHYSICAL-LOCATION-ID__
+ - name: target-pe
+ in: path
+ description: The Target provider edge router
+ required: true
+ type: string
+ example: __TARGET-PE__
+ - name: availability-zone-name
+ in: path
+ description: Name of the availability zone
+ required: true
+ type: string
+ example: __AVAILABILITY-ZONE-NAME__
+ - name: body
+ in: body
+ description: ctag-pool object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/ctag-pool"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing ctag-pool
+ description: delete an existing ctag-pool
+ operationId: deleteCloudInfrastructureComplexesComplexCtagPoolsCtagPool
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: physical-location-id
+ in: path
+ description: Unique identifier for physical location, e.g., CLLI
+ required: true
+ type: string
+ example: __PHYSICAL-LOCATION-ID__
+ - name: target-pe
+ in: path
+ description: The Target provider edge router
+ required: true
+ type: string
+ example: __TARGET-PE__
+ - name: availability-zone-name
+ in: path
+ description: Name of the availability zone
+ required: true
+ type: string
+ example: __AVAILABILITY-ZONE-NAME__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns ctag-pools
+ description: returns ctag-pools
+ operationId: getCloudInfrastructureComplexesComplexCtagPools
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/ctag-pools"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: physical-location-id
+ in: path
+ description: Unique identifier for physical location, e.g., CLLI
+ required: true
+ type: string
+ example: __PHYSICAL-LOCATION-ID__
+ - name: data-center-code
+ in: query
+ description: Data center code which can be an alternate way to identify a complex
+ required: false
+ type: string
+ - name: complex-name
+ in: query
+ description: Gamma complex name for LCP instance.
+ required: false
+ type: string
+ - name: identity-url
+ in: query
+ description: URL of the keystone identity service
+ required: false
+ type: string
+ /cloud-infrastructure/complexes/complex/{physical-location-id}/relationship-list/relationship:
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructureComplexesComplexRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: physical-location-id
+ in: path
+ description: Unique identifier for physical location, e.g., CLLI
+ required: true
+ type: string
+ example: __PHYSICAL-LOCATION-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureComplexesComplex.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructureComplexesComplexRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: physical-location-id
+ in: path
+ description: Unique identifier for physical location, e.g., CLLI
+ required: true
+ type: string
+ example: __PHYSICAL-LOCATION-ID__
+ /cloud-infrastructure/complexes/complex/{physical-location-id}:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns complex
+ description: returns complex
+ operationId: getCloudInfrastructureComplexesComplex
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/complex"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: physical-location-id
+ in: path
+ description: Unique identifier for physical location, e.g., CLLI
+ required: true
+ type: string
+ example: __PHYSICAL-LOCATION-ID__
+ - name: data-center-code
+ in: query
+ description: Data center code which can be an alternate way to identify a complex
+ required: false
+ type: string
+ - name: complex-name
+ in: query
+ description: Gamma complex name for LCP instance.
+ required: false
+ type: string
+ - name: identity-url
+ in: query
+ description: URL of the keystone identity service
+ required: false
+ type: string
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing complex
+ description: |
+ Create or update an existing complex.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructureComplexesComplex
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: physical-location-id
+ in: path
+ description: Unique identifier for physical location, e.g., CLLI
+ required: true
+ type: string
+ example: __PHYSICAL-LOCATION-ID__
+ - name: body
+ in: body
+ description: complex object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureComplexesComplex.json)
+ required: true
+ schema:
+ $ref: "#/definitions/complex"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing complex
+ description: |
+ Update an existing complex
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructureComplexesComplex
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: physical-location-id
+ in: path
+ description: Unique identifier for physical location, e.g., CLLI
+ required: true
+ type: string
+ example: __PHYSICAL-LOCATION-ID__
+ - name: body
+ in: body
+ description: complex object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/complex"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing complex
+ description: delete an existing complex
+ operationId: deleteCloudInfrastructureComplexesComplex
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: physical-location-id
+ in: path
+ description: Unique identifier for physical location, e.g., CLLI
+ required: true
+ type: string
+ example: __PHYSICAL-LOCATION-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /cloud-infrastructure/complexes:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns complexes
+ description: returns complexes
+ operationId: getCloudInfrastructureComplexes
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/complexes"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship:
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroupRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: volume-group-id
+ in: path
+ description: Unique ID of volume-group.
+ required: true
+ type: string
+ example: __VOLUME-GROUP-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroupRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: volume-group-id
+ in: path
+ description: Unique ID of volume-group.
+ required: true
+ type: string
+ example: __VOLUME-GROUP-ID__
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns volume-group
+ description: returns volume-group
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/volume-group"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: volume-group-id
+ in: path
+ description: Unique ID of volume-group.
+ required: true
+ type: string
+ example: __VOLUME-GROUP-ID__
+ - name: cloud-type
+ in: query
+ description: Type of the cloud (e.g., openstack)
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ required: false
+ type: string
+ - name: volume-group-name
+ in: query
+ description: Name of the volume group.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this volume-group
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: false
+ type: string
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing volume-group
+ description: |
+ Create or update an existing volume-group.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: volume-group-id
+ in: path
+ description: Unique ID of volume-group.
+ required: true
+ type: string
+ example: __VOLUME-GROUP-ID__
+ - name: body
+ in: body
+ description: volume-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json)
+ required: true
+ schema:
+ $ref: "#/definitions/volume-group"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing volume-group
+ description: |
+ Update an existing volume-group
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: volume-group-id
+ in: path
+ description: Unique ID of volume-group.
+ required: true
+ type: string
+ example: __VOLUME-GROUP-ID__
+ - name: body
+ in: body
+ description: volume-group object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/volume-group"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing volume-group
+ description: delete an existing volume-group
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: volume-group-id
+ in: path
+ description: Unique ID of volume-group.
+ required: true
+ type: string
+ example: __VOLUME-GROUP-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns volume-groups
+ description: returns volume-groups
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionVolumeGroups
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/volume-groups"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: cloud-type
+ in: query
+ description: Type of the cloud (e.g., openstack)
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ required: false
+ type: string
+ /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:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolumeRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: volume-id
+ in: path
+ description: Unique ID of block storage volume relative to the vserver.
+ required: true
+ type: string
+ example: __VOLUME-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolumeRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: volume-id
+ in: path
+ description: Unique ID of block storage volume relative to the vserver.
+ required: true
+ type: string
+ example: __VOLUME-ID__
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns volume
+ description: returns volume
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/volume"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: volume-id
+ in: path
+ description: Unique ID of block storage volume relative to the vserver.
+ required: true
+ type: string
+ example: __VOLUME-ID__
+ - name: cloud-type
+ in: query
+ description: Type of the cloud (e.g., openstack)
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ required: false
+ type: string
+ - name: tenant-name
+ in: query
+ description: Readable name of tenant
+ required: false
+ type: string
+ - name: tenant-context
+ in: query
+ description: This field will store the tenant context.
+ required: false
+ type: string
+ - name: vserver-name
+ in: query
+ description: Name of vserver
+ required: false
+ type: string
+ - name: vserver-name2
+ in: query
+ description: Alternative name of vserver
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ required: false
+ type: boolean
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing volume
+ description: |
+ Create or update an existing volume.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: volume-id
+ in: path
+ description: Unique ID of block storage volume relative to the vserver.
+ required: true
+ type: string
+ example: __VOLUME-ID__
+ - name: body
+ in: body
+ description: volume object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json)
+ required: true
+ schema:
+ $ref: "#/definitions/volume"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing volume
+ description: |
+ Update an existing volume
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: volume-id
+ in: path
+ description: Unique ID of block storage volume relative to the vserver.
+ required: true
+ type: string
+ example: __VOLUME-ID__
+ - name: body
+ in: body
+ description: volume object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/volume"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing volume
+ description: delete an existing volume
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: volume-id
+ in: path
+ description: Unique ID of block storage volume relative to the vserver.
+ required: true
+ type: string
+ example: __VOLUME-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns volumes
+ description: returns volumes
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumes
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/volumes"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: cloud-type
+ in: query
+ description: Type of the cloud (e.g., openstack)
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ required: false
+ type: string
+ - name: tenant-name
+ in: query
+ description: Readable name of tenant
+ required: false
+ type: string
+ - name: tenant-context
+ in: query
+ description: This field will store the tenant context.
+ required: false
+ type: string
+ - name: vserver-name
+ in: query
+ description: Name of vserver
+ required: false
+ type: string
+ - name: vserver-name2
+ in: query
+ description: Alternative name of vserver
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ required: false
+ type: boolean
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/relationship-list/relationship:
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ /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:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ /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:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ /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:
+ tags:
+ - CloudInfrastructure
+ summary: returns l3-interface-ipv4-address-list
+ description: returns l3-interface-ipv4-address-list
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: cloud-type
+ in: query
+ description: Type of the cloud (e.g., openstack)
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ required: false
+ type: string
+ - name: tenant-name
+ in: query
+ description: Readable name of tenant
+ required: false
+ type: string
+ - name: tenant-context
+ in: query
+ description: This field will store the tenant context.
+ required: false
+ type: string
+ - name: vserver-name
+ in: query
+ description: Name of vserver
+ required: false
+ type: string
+ - name: vserver-name2
+ in: query
+ description: Alternative name of vserver
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ required: false
+ type: boolean
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: vpn-key
+ in: query
+ description: This indicates the customers VPN ID associated with this vlan
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface that address belongs to
+ required: false
+ type: string
+ - name: neutron-subnet-id
+ in: query
+ description: Neutron id of subnet that address belongs to
+ required: false
+ type: string
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing l3-interface-ipv4-address-list
+ description: |
+ Create or update an existing l3-interface-ipv4-address-list.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv4-address-list"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing l3-interface-ipv4-address-list
+ description: |
+ Update an existing l3-interface-ipv4-address-list
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing l3-interface-ipv4-address-list
+ description: delete an existing l3-interface-ipv4-address-list
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /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:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ /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:
+ tags:
+ - CloudInfrastructure
+ summary: returns l3-interface-ipv6-address-list
+ description: returns l3-interface-ipv6-address-list
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: cloud-type
+ in: query
+ description: Type of the cloud (e.g., openstack)
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ required: false
+ type: string
+ - name: tenant-name
+ in: query
+ description: Readable name of tenant
+ required: false
+ type: string
+ - name: tenant-context
+ in: query
+ description: This field will store the tenant context.
+ required: false
+ type: string
+ - name: vserver-name
+ in: query
+ description: Name of vserver
+ required: false
+ type: string
+ - name: vserver-name2
+ in: query
+ description: Alternative name of vserver
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ required: false
+ type: boolean
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: vpn-key
+ in: query
+ description: This indicates the customers VPN ID associated with this vlan
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface that address belongs to
+ required: false
+ type: string
+ - name: neutron-subnet-id
+ in: query
+ description: Neutron id of subnet that address belongs to
+ required: false
+ type: string
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing l3-interface-ipv6-address-list
+ description: |
+ Create or update an existing l3-interface-ipv6-address-list.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing l3-interface-ipv6-address-list
+ description: |
+ Update an existing l3-interface-ipv6-address-list
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing l3-interface-ipv6-address-list
+ description: delete an existing l3-interface-ipv6-address-list
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /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:
+ tags:
+ - CloudInfrastructure
+ summary: returns vlan
+ description: returns vlan
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/vlan"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: cloud-type
+ in: query
+ description: Type of the cloud (e.g., openstack)
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ required: false
+ type: string
+ - name: tenant-name
+ in: query
+ description: Readable name of tenant
+ required: false
+ type: string
+ - name: tenant-context
+ in: query
+ description: This field will store the tenant context.
+ required: false
+ type: string
+ - name: vserver-name
+ in: query
+ description: Name of vserver
+ required: false
+ type: string
+ - name: vserver-name2
+ in: query
+ description: Alternative name of vserver
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ required: false
+ type: boolean
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: vpn-key
+ in: query
+ description: This indicates the customers VPN ID associated with this vlan
+ required: false
+ type: string
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing vlan
+ description: |
+ Create or update an existing vlan.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: body
+ in: body
+ description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json)
+ required: true
+ schema:
+ $ref: "#/definitions/vlan"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing vlan
+ description: |
+ Update an existing vlan
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: body
+ in: body
+ description: vlan object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/vlan"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing vlan
+ description: delete an existing vlan
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /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:
+ tags:
+ - CloudInfrastructure
+ summary: returns vlans
+ description: returns vlans
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlans
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/vlans"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: cloud-type
+ in: query
+ description: Type of the cloud (e.g., openstack)
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ required: false
+ type: string
+ - name: tenant-name
+ in: query
+ description: Readable name of tenant
+ required: false
+ type: string
+ - name: tenant-context
+ in: query
+ description: This field will store the tenant context.
+ required: false
+ type: string
+ - name: vserver-name
+ in: query
+ description: Name of vserver
+ required: false
+ type: string
+ - name: vserver-name2
+ in: query
+ description: Alternative name of vserver
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ required: false
+ type: boolean
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ /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:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ /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:
+ tags:
+ - CloudInfrastructure
+ summary: returns sriov-vf
+ description: returns sriov-vf
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/sriov-vf"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: cloud-type
+ in: query
+ description: Type of the cloud (e.g., openstack)
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ required: false
+ type: string
+ - name: tenant-name
+ in: query
+ description: Readable name of tenant
+ required: false
+ type: string
+ - name: tenant-context
+ in: query
+ description: This field will store the tenant context.
+ required: false
+ type: string
+ - name: vserver-name
+ in: query
+ description: Name of vserver
+ required: false
+ type: string
+ - name: vserver-name2
+ in: query
+ description: Alternative name of vserver
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ required: false
+ type: boolean
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vf-vlan-filter
+ in: query
+ description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
+ required: false
+ type: string
+ - name: vf-mac-filter
+ in: query
+ description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
+ required: false
+ type: string
+ - name: vf-vlan-strip
+ in: query
+ description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
+ required: false
+ type: boolean
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface
+ required: false
+ type: string
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing sriov-vf
+ description: |
+ Create or update an existing sriov-vf.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: body
+ in: body
+ description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json)
+ required: true
+ schema:
+ $ref: "#/definitions/sriov-vf"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing sriov-vf
+ description: |
+ Update an existing sriov-vf
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: body
+ in: body
+ description: sriov-vf object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/sriov-vf"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing sriov-vf
+ description: delete an existing sriov-vf
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /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:
+ tags:
+ - CloudInfrastructure
+ summary: returns sriov-vfs
+ description: returns sriov-vfs
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfs
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/sriov-vfs"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: cloud-type
+ in: query
+ description: Type of the cloud (e.g., openstack)
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ required: false
+ type: string
+ - name: tenant-name
+ in: query
+ description: Readable name of tenant
+ required: false
+ type: string
+ - name: tenant-context
+ in: query
+ description: This field will store the tenant context.
+ required: false
+ type: string
+ - name: vserver-name
+ in: query
+ description: Name of vserver
+ required: false
+ type: string
+ - name: vserver-name2
+ in: query
+ description: Alternative name of vserver
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ required: false
+ type: boolean
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ /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:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ /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:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ /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:
+ tags:
+ - CloudInfrastructure
+ summary: returns l3-interface-ipv4-address-list
+ description: returns l3-interface-ipv4-address-list
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: cloud-type
+ in: query
+ description: Type of the cloud (e.g., openstack)
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ required: false
+ type: string
+ - name: tenant-name
+ in: query
+ description: Readable name of tenant
+ required: false
+ type: string
+ - name: tenant-context
+ in: query
+ description: This field will store the tenant context.
+ required: false
+ type: string
+ - name: vserver-name
+ in: query
+ description: Name of vserver
+ required: false
+ type: string
+ - name: vserver-name2
+ in: query
+ description: Alternative name of vserver
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ required: false
+ type: boolean
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface that address belongs to
+ required: false
+ type: string
+ - name: neutron-subnet-id
+ in: query
+ description: Neutron id of subnet that address belongs to
+ required: false
+ type: string
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing l3-interface-ipv4-address-list
+ description: |
+ Create or update an existing l3-interface-ipv4-address-list.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv4-address-list"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing l3-interface-ipv4-address-list
+ description: |
+ Update an existing l3-interface-ipv4-address-list
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing l3-interface-ipv4-address-list
+ description: delete an existing l3-interface-ipv4-address-list
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /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:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ /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:
+ tags:
+ - CloudInfrastructure
+ summary: returns l3-interface-ipv6-address-list
+ description: returns l3-interface-ipv6-address-list
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: cloud-type
+ in: query
+ description: Type of the cloud (e.g., openstack)
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ required: false
+ type: string
+ - name: tenant-name
+ in: query
+ description: Readable name of tenant
+ required: false
+ type: string
+ - name: tenant-context
+ in: query
+ description: This field will store the tenant context.
+ required: false
+ type: string
+ - name: vserver-name
+ in: query
+ description: Name of vserver
+ required: false
+ type: string
+ - name: vserver-name2
+ in: query
+ description: Alternative name of vserver
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ required: false
+ type: boolean
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface that address belongs to
+ required: false
+ type: string
+ - name: neutron-subnet-id
+ in: query
+ description: Neutron id of subnet that address belongs to
+ required: false
+ type: string
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing l3-interface-ipv6-address-list
+ description: |
+ Create or update an existing l3-interface-ipv6-address-list.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing l3-interface-ipv6-address-list
+ description: |
+ Update an existing l3-interface-ipv6-address-list
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing l3-interface-ipv6-address-list
+ description: delete an existing l3-interface-ipv6-address-list
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /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:
+ tags:
+ - CloudInfrastructure
+ summary: returns l-interface
+ description: returns l-interface
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l-interface"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: cloud-type
+ in: query
+ description: Type of the cloud (e.g., openstack)
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ required: false
+ type: string
+ - name: tenant-name
+ in: query
+ description: Readable name of tenant
+ required: false
+ type: string
+ - name: tenant-context
+ in: query
+ description: This field will store the tenant context.
+ required: false
+ type: string
+ - name: vserver-name
+ in: query
+ description: Name of vserver
+ required: false
+ type: string
+ - name: vserver-name2
+ in: query
+ description: Alternative name of vserver
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ required: false
+ type: boolean
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing l-interface
+ description: |
+ Create or update an existing l-interface.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l-interface"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing l-interface
+ description: |
+ Update an existing l-interface
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: l-interface object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l-interface"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing l-interface
+ description: delete an existing l-interface
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns l-interfaces
+ description: returns l-interfaces
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfaces
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l-interfaces"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: cloud-type
+ in: query
+ description: Type of the cloud (e.g., openstack)
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ required: false
+ type: string
+ - name: tenant-name
+ in: query
+ description: Readable name of tenant
+ required: false
+ type: string
+ - name: tenant-context
+ in: query
+ description: This field will store the tenant context.
+ required: false
+ type: string
+ - name: vserver-name
+ in: query
+ description: Name of vserver
+ required: false
+ type: string
+ - name: vserver-name2
+ in: query
+ description: Alternative name of vserver
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ required: false
+ type: boolean
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns vserver
+ description: returns vserver
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/vserver"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: cloud-type
+ in: query
+ description: Type of the cloud (e.g., openstack)
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ required: false
+ type: string
+ - name: tenant-name
+ in: query
+ description: Readable name of tenant
+ required: false
+ type: string
+ - name: tenant-context
+ in: query
+ description: This field will store the tenant context.
+ required: false
+ type: string
+ - name: vserver-name
+ in: query
+ description: Name of vserver
+ required: false
+ type: string
+ - name: vserver-name2
+ in: query
+ description: Alternative name of vserver
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ required: false
+ type: boolean
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing vserver
+ description: |
+ Create or update an existing vserver.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: body
+ in: body
+ description: vserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json)
+ required: true
+ schema:
+ $ref: "#/definitions/vserver"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing vserver
+ description: |
+ Update an existing vserver
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: body
+ in: body
+ description: vserver object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/vserver"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing vserver
+ description: delete an existing vserver
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: vserver-id
+ in: path
+ description: Unique identifier for this vserver relative to its tenant
+ required: true
+ type: string
+ example: __VSERVER-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns vservers
+ description: returns vservers
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVservers
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/vservers"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: cloud-type
+ in: query
+ description: Type of the cloud (e.g., openstack)
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ required: false
+ type: string
+ - name: tenant-name
+ in: query
+ description: Readable name of tenant
+ required: false
+ type: string
+ - name: tenant-context
+ in: query
+ description: This field will store the tenant context.
+ required: false
+ type: string
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/relationship-list/relationship:
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns tenant
+ description: returns tenant
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenant
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/tenant"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: cloud-type
+ in: query
+ description: Type of the cloud (e.g., openstack)
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ required: false
+ type: string
+ - name: tenant-name
+ in: query
+ description: Readable name of tenant
+ required: false
+ type: string
+ - name: tenant-context
+ in: query
+ description: This field will store the tenant context.
+ required: false
+ type: string
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing tenant
+ description: |
+ Create or update an existing tenant.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenant
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: body
+ in: body
+ description: tenant object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json)
+ required: true
+ schema:
+ $ref: "#/definitions/tenant"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing tenant
+ description: |
+ Update an existing tenant
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenant
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: body
+ in: body
+ description: tenant object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/tenant"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing tenant
+ description: delete an existing tenant
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenant
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: tenant-id
+ in: path
+ description: Unique id relative to the cloud-region.
+ required: true
+ type: string
+ example: __TENANT-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns tenants
+ description: returns tenants
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionTenants
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/tenants"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: cloud-type
+ in: query
+ description: Type of the cloud (e.g., openstack)
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ required: false
+ type: string
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship:
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: flavor-id
+ in: path
+ description: Flavor id, expected to be unique across cloud-region.
+ required: true
+ type: string
+ example: __FLAVOR-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: flavor-id
+ in: path
+ description: Flavor id, expected to be unique across cloud-region.
+ required: true
+ type: string
+ example: __FLAVOR-ID__
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns flavor
+ description: returns flavor
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/flavor"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: flavor-id
+ in: path
+ description: Flavor id, expected to be unique across cloud-region.
+ required: true
+ type: string
+ example: __FLAVOR-ID__
+ - name: cloud-type
+ in: query
+ description: Type of the cloud (e.g., openstack)
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ required: false
+ type: string
+ - name: flavor-name
+ in: query
+ description: Flavor name
+ required: false
+ type: string
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing flavor
+ description: |
+ Create or update an existing flavor.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: flavor-id
+ in: path
+ description: Flavor id, expected to be unique across cloud-region.
+ required: true
+ type: string
+ example: __FLAVOR-ID__
+ - name: body
+ in: body
+ description: flavor object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)
+ required: true
+ schema:
+ $ref: "#/definitions/flavor"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing flavor
+ description: |
+ Update an existing flavor
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: flavor-id
+ in: path
+ description: Flavor id, expected to be unique across cloud-region.
+ required: true
+ type: string
+ example: __FLAVOR-ID__
+ - name: body
+ in: body
+ description: flavor object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/flavor"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing flavor
+ description: delete an existing flavor
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: flavor-id
+ in: path
+ description: Flavor id, expected to be unique across cloud-region.
+ required: true
+ type: string
+ example: __FLAVOR-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns flavors
+ description: returns flavors
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavors
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/flavors"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: cloud-type
+ in: query
+ description: Type of the cloud (e.g., openstack)
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ required: false
+ type: string
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship:
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: group-id
+ in: path
+ description: Group id, expected to be unique across cloud-region.
+ required: true
+ type: string
+ example: __GROUP-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: group-id
+ in: path
+ description: Group id, expected to be unique across cloud-region.
+ required: true
+ type: string
+ example: __GROUP-ID__
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns group-assignment
+ description: returns group-assignment
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/group-assignment"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: group-id
+ in: path
+ description: Group id, expected to be unique across cloud-region.
+ required: true
+ type: string
+ example: __GROUP-ID__
+ - name: cloud-type
+ in: query
+ description: Type of the cloud (e.g., openstack)
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ required: false
+ type: string
+ - name: group-type
+ in: query
+ description: Group type - the type of group this instance refers to
+ required: false
+ type: string
+ - name: group-name
+ in: query
+ description: Group name - name assigned to the group
+ required: false
+ type: string
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing group-assignment
+ description: |
+ Create or update an existing group-assignment.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: group-id
+ in: path
+ description: Group id, expected to be unique across cloud-region.
+ required: true
+ type: string
+ example: __GROUP-ID__
+ - name: body
+ in: body
+ description: group-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)
+ required: true
+ schema:
+ $ref: "#/definitions/group-assignment"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing group-assignment
+ description: |
+ Update an existing group-assignment
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: group-id
+ in: path
+ description: Group id, expected to be unique across cloud-region.
+ required: true
+ type: string
+ example: __GROUP-ID__
+ - name: body
+ in: body
+ description: group-assignment object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/group-assignment"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing group-assignment
+ description: delete an existing group-assignment
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: group-id
+ in: path
+ description: Group id, expected to be unique across cloud-region.
+ required: true
+ type: string
+ example: __GROUP-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns group-assignments
+ description: returns group-assignments
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignments
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/group-assignments"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: cloud-type
+ in: query
+ description: Type of the cloud (e.g., openstack)
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ required: false
+ type: string
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship:
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: snapshot-id
+ in: path
+ description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
+ required: true
+ type: string
+ example: __SNAPSHOT-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: snapshot-id
+ in: path
+ description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
+ required: true
+ type: string
+ example: __SNAPSHOT-ID__
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns snapshot
+ description: returns snapshot
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/snapshot"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: snapshot-id
+ in: path
+ description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
+ required: true
+ type: string
+ example: __SNAPSHOT-ID__
+ - name: cloud-type
+ in: query
+ description: Type of the cloud (e.g., openstack)
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ required: false
+ type: string
+ - name: snapshot-name
+ in: query
+ description: Snapshot name
+ required: false
+ type: string
+ - name: application
+ in: query
+ description: The application that the image instantiates.
+ required: false
+ type: string
+ - name: application-vendor
+ in: query
+ description: The vendor of the application.
+ required: false
+ type: string
+ - name: application-version
+ in: query
+ description: The version of the application.
+ required: false
+ type: string
+ - name: prev-snapshot-id
+ in: query
+ description: This field contains the UUID of the previous snapshot (if any).
+ required: false
+ type: string
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing snapshot
+ description: |
+ Create or update an existing snapshot.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: snapshot-id
+ in: path
+ description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
+ required: true
+ type: string
+ example: __SNAPSHOT-ID__
+ - name: body
+ in: body
+ description: snapshot object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)
+ required: true
+ schema:
+ $ref: "#/definitions/snapshot"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing snapshot
+ description: |
+ Update an existing snapshot
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: snapshot-id
+ in: path
+ description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
+ required: true
+ type: string
+ example: __SNAPSHOT-ID__
+ - name: body
+ in: body
+ description: snapshot object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/snapshot"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing snapshot
+ description: delete an existing snapshot
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: snapshot-id
+ in: path
+ description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
+ required: true
+ type: string
+ example: __SNAPSHOT-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns snapshots
+ description: returns snapshots
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshots
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/snapshots"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: cloud-type
+ in: query
+ description: Type of the cloud (e.g., openstack)
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ required: false
+ type: string
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship:
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: image-id
+ in: path
+ description: Image id, expected to be unique across cloud region
+ required: true
+ type: string
+ example: __IMAGE-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: image-id
+ in: path
+ description: Image id, expected to be unique across cloud region
+ required: true
+ type: string
+ example: __IMAGE-ID__
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns metadatum
+ description: returns metadatum
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/metadatum"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: image-id
+ in: path
+ description: Image id, expected to be unique across cloud region
+ required: true
+ type: string
+ example: __IMAGE-ID__
+ - name: metaname
+ in: path
+ required: true
+ type: string
+ example: __METANAME__
+ - name: cloud-type
+ in: query
+ description: Type of the cloud (e.g., openstack)
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ required: false
+ type: string
+ - name: image-name
+ in: query
+ description: Image name
+ required: false
+ type: string
+ - name: application
+ in: query
+ description: The application that the image instantiates.
+ required: false
+ type: string
+ - name: application-vendor
+ in: query
+ description: The vendor of the application.
+ required: false
+ type: string
+ - name: application-version
+ in: query
+ description: The version of the application.
+ required: false
+ type: string
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing metadatum
+ description: |
+ Create or update an existing metadatum.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: image-id
+ in: path
+ description: Image id, expected to be unique across cloud region
+ required: true
+ type: string
+ example: __IMAGE-ID__
+ - name: metaname
+ in: path
+ required: true
+ type: string
+ example: __METANAME__
+ - name: body
+ in: body
+ description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum.json)
+ required: true
+ schema:
+ $ref: "#/definitions/metadatum"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing metadatum
+ description: |
+ Update an existing metadatum
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: image-id
+ in: path
+ description: Image id, expected to be unique across cloud region
+ required: true
+ type: string
+ example: __IMAGE-ID__
+ - name: metaname
+ in: path
+ required: true
+ type: string
+ example: __METANAME__
+ - name: body
+ in: body
+ description: metadatum object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/metadatum"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing metadatum
+ description: delete an existing metadatum
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: image-id
+ in: path
+ description: Image id, expected to be unique across cloud region
+ required: true
+ type: string
+ example: __IMAGE-ID__
+ - name: metaname
+ in: path
+ required: true
+ type: string
+ example: __METANAME__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns metadata
+ description: returns metadata
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadata
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/metadata"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: image-id
+ in: path
+ description: Image id, expected to be unique across cloud region
+ required: true
+ type: string
+ example: __IMAGE-ID__
+ - name: cloud-type
+ in: query
+ description: Type of the cloud (e.g., openstack)
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ required: false
+ type: string
+ - name: image-name
+ in: query
+ description: Image name
+ required: false
+ type: string
+ - name: application
+ in: query
+ description: The application that the image instantiates.
+ required: false
+ type: string
+ - name: application-vendor
+ in: query
+ description: The vendor of the application.
+ required: false
+ type: string
+ - name: application-version
+ in: query
+ description: The version of the application.
+ required: false
+ type: string
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns image
+ description: returns image
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImage
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/image"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: image-id
+ in: path
+ description: Image id, expected to be unique across cloud region
+ required: true
+ type: string
+ example: __IMAGE-ID__
+ - name: cloud-type
+ in: query
+ description: Type of the cloud (e.g., openstack)
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ required: false
+ type: string
+ - name: image-name
+ in: query
+ description: Image name
+ required: false
+ type: string
+ - name: application
+ in: query
+ description: The application that the image instantiates.
+ required: false
+ type: string
+ - name: application-vendor
+ in: query
+ description: The vendor of the application.
+ required: false
+ type: string
+ - name: application-version
+ in: query
+ description: The version of the application.
+ required: false
+ type: string
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing image
+ description: |
+ Create or update an existing image.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: image-id
+ in: path
+ description: Image id, expected to be unique across cloud region
+ required: true
+ type: string
+ example: __IMAGE-ID__
+ - name: body
+ in: body
+ description: image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)
+ required: true
+ schema:
+ $ref: "#/definitions/image"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing image
+ description: |
+ Update an existing image
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: image-id
+ in: path
+ description: Image id, expected to be unique across cloud region
+ required: true
+ type: string
+ example: __IMAGE-ID__
+ - name: body
+ in: body
+ description: image object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/image"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing image
+ description: delete an existing image
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImage
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: image-id
+ in: path
+ description: Image id, expected to be unique across cloud region
+ required: true
+ type: string
+ example: __IMAGE-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns images
+ description: returns images
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionImages
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/images"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: cloud-type
+ in: query
+ description: Type of the cloud (e.g., openstack)
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ required: false
+ type: string
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship:
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: switch-name
+ in: path
+ description: DVS switch name
+ required: true
+ type: string
+ example: __SWITCH-NAME__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: switch-name
+ in: path
+ description: DVS switch name
+ required: true
+ type: string
+ example: __SWITCH-NAME__
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns dvs-switch
+ description: returns dvs-switch
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/dvs-switch"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: switch-name
+ in: path
+ description: DVS switch name
+ required: true
+ type: string
+ example: __SWITCH-NAME__
+ - name: cloud-type
+ in: query
+ description: Type of the cloud (e.g., openstack)
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ required: false
+ type: string
+ - name: vcenter-url
+ in: query
+ description: URL used to reach the vcenter
+ required: false
+ type: string
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing dvs-switch
+ description: |
+ Create or update an existing dvs-switch.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: switch-name
+ in: path
+ description: DVS switch name
+ required: true
+ type: string
+ example: __SWITCH-NAME__
+ - name: body
+ in: body
+ description: dvs-switch object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)
+ required: true
+ schema:
+ $ref: "#/definitions/dvs-switch"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing dvs-switch
+ description: |
+ Update an existing dvs-switch
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: switch-name
+ in: path
+ description: DVS switch name
+ required: true
+ type: string
+ example: __SWITCH-NAME__
+ - name: body
+ in: body
+ description: dvs-switch object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/dvs-switch"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing dvs-switch
+ description: delete an existing dvs-switch
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: switch-name
+ in: path
+ description: DVS switch name
+ required: true
+ type: string
+ example: __SWITCH-NAME__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns dvs-switches
+ description: returns dvs-switches
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitches
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/dvs-switches"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: cloud-type
+ in: query
+ description: Type of the cloud (e.g., openstack)
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ required: false
+ type: string
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship:
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: network-uuid
+ in: path
+ description: UUID of the network. Unique across a cloud-region
+ required: true
+ type: string
+ example: __NETWORK-UUID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: network-uuid
+ in: path
+ description: UUID of the network. Unique across a cloud-region
+ required: true
+ type: string
+ example: __NETWORK-UUID__
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns oam-network
+ description: returns oam-network
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/oam-network"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: network-uuid
+ in: path
+ description: UUID of the network. Unique across a cloud-region
+ required: true
+ type: string
+ example: __NETWORK-UUID__
+ - name: cloud-type
+ in: query
+ description: Type of the cloud (e.g., openstack)
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network.
+ required: false
+ type: string
+ - name: cvlan-tag
+ in: query
+ description: cvlan-id
+ required: false
+ type: integer
+ format: int64
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing oam-network
+ description: |
+ Create or update an existing oam-network.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: network-uuid
+ in: path
+ description: UUID of the network. Unique across a cloud-region
+ required: true
+ type: string
+ example: __NETWORK-UUID__
+ - name: body
+ in: body
+ description: oam-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)
+ required: true
+ schema:
+ $ref: "#/definitions/oam-network"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing oam-network
+ description: |
+ Update an existing oam-network
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: network-uuid
+ in: path
+ description: UUID of the network. Unique across a cloud-region
+ required: true
+ type: string
+ example: __NETWORK-UUID__
+ - name: body
+ in: body
+ description: oam-network object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/oam-network"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing oam-network
+ description: delete an existing oam-network
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: network-uuid
+ in: path
+ description: UUID of the network. Unique across a cloud-region
+ required: true
+ type: string
+ example: __NETWORK-UUID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns oam-networks
+ description: returns oam-networks
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworks
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/oam-networks"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: cloud-type
+ in: query
+ description: Type of the cloud (e.g., openstack)
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ required: false
+ type: string
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}/relationship-list/relationship:
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: availability-zone-name
+ in: path
+ description: Name of the availability zone. Unique across a cloud region
+ required: true
+ type: string
+ example: __AVAILABILITY-ZONE-NAME__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: availability-zone-name
+ in: path
+ description: Name of the availability zone. Unique across a cloud region
+ required: true
+ type: string
+ example: __AVAILABILITY-ZONE-NAME__
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns availability-zone
+ description: returns availability-zone
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/availability-zone"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: availability-zone-name
+ in: path
+ description: Name of the availability zone. Unique across a cloud region
+ required: true
+ type: string
+ example: __AVAILABILITY-ZONE-NAME__
+ - name: cloud-type
+ in: query
+ description: Type of the cloud (e.g., openstack)
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ required: false
+ type: string
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing availability-zone
+ description: |
+ Create or update an existing availability-zone.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: availability-zone-name
+ in: path
+ description: Name of the availability zone. Unique across a cloud region
+ required: true
+ type: string
+ example: __AVAILABILITY-ZONE-NAME__
+ - name: body
+ in: body
+ description: availability-zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)
+ required: true
+ schema:
+ $ref: "#/definitions/availability-zone"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing availability-zone
+ description: |
+ Update an existing availability-zone
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: availability-zone-name
+ in: path
+ description: Name of the availability zone. Unique across a cloud region
+ required: true
+ type: string
+ example: __AVAILABILITY-ZONE-NAME__
+ - name: body
+ in: body
+ description: availability-zone object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/availability-zone"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing availability-zone
+ description: delete an existing availability-zone
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: availability-zone-name
+ in: path
+ description: Name of the availability zone. Unique across a cloud region
+ required: true
+ type: string
+ example: __AVAILABILITY-ZONE-NAME__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns availability-zones
+ description: returns availability-zones
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionAvailabilityZones
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/availability-zones"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: cloud-type
+ in: query
+ description: Type of the cloud (e.g., openstack)
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ required: false
+ type: string
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/relationship-list/relationship:
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegion.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship:
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: vip-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __VIP-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: vip-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __VIP-IPV4-ADDRESS__
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns vip-ipv4-address-list
+ description: returns vip-ipv4-address-list
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/vip-ipv4-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: vip-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __VIP-IPV4-ADDRESS__
+ - name: cloud-type
+ in: query
+ description: Type of the cloud (e.g., openstack)
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface that address belongs to
+ required: false
+ type: string
+ - name: neutron-subnet-id
+ in: query
+ description: Neutron id of subnet that address belongs to
+ required: false
+ type: string
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing vip-ipv4-address-list
+ description: |
+ Create or update an existing vip-ipv4-address-list.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: vip-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __VIP-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: vip-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/vip-ipv4-address-list"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing vip-ipv4-address-list
+ description: |
+ Update an existing vip-ipv4-address-list
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: vip-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __VIP-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: vip-ipv4-address-list object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/vip-ipv4-address-list"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing vip-ipv4-address-list
+ description: delete an existing vip-ipv4-address-list
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: vip-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __VIP-IPV4-ADDRESS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship:
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: vip-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __VIP-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: vip-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __VIP-IPV6-ADDRESS__
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns vip-ipv6-address-list
+ description: returns vip-ipv6-address-list
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/vip-ipv6-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: vip-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __VIP-IPV6-ADDRESS__
+ - name: cloud-type
+ in: query
+ description: Type of the cloud (e.g., openstack)
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface that address belongs to
+ required: false
+ type: string
+ - name: neutron-subnet-id
+ in: query
+ description: Neutron id of subnet that address belongs to
+ required: false
+ type: string
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing vip-ipv6-address-list
+ description: |
+ Create or update an existing vip-ipv6-address-list.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: vip-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __VIP-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: vip-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/vip-ipv6-address-list"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing vip-ipv6-address-list
+ description: |
+ Update an existing vip-ipv6-address-list
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: vip-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __VIP-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: vip-ipv6-address-list object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/vip-ipv6-address-list"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing vip-ipv6-address-list
+ description: delete an existing vip-ipv6-address-list
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: vip-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __VIP-IPV6-ADDRESS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns cloud-region
+ description: returns cloud-region
+ operationId: getCloudInfrastructureCloudRegionsCloudRegion
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/cloud-region"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: cloud-type
+ in: query
+ description: Type of the cloud (e.g., openstack)
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ required: false
+ type: string
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing cloud-region
+ description: |
+ Create or update an existing cloud-region.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegion
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: body
+ in: body
+ description: cloud-region object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegion.json)
+ required: true
+ schema:
+ $ref: "#/definitions/cloud-region"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing cloud-region
+ description: |
+ Update an existing cloud-region
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructureCloudRegionsCloudRegion
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: body
+ in: body
+ description: cloud-region object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/cloud-region"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing cloud-region
+ description: delete an existing cloud-region
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegion
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ example: __CLOUD-OWNER__
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ example: __CLOUD-REGION-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /cloud-infrastructure/cloud-regions:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns cloud-regions
+ description: returns cloud-regions
+ operationId: getCloudInfrastructureCloudRegions
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/cloud-regions"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship:
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: nm-profile-name
+ in: path
+ description: Unique name of network profile.
+ required: true
+ type: string
+ example: __NM-PROFILE-NAME__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureNetworkProfilesNetworkProfile.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: nm-profile-name
+ in: path
+ description: Unique name of network profile.
+ required: true
+ type: string
+ example: __NM-PROFILE-NAME__
+ /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns network-profile
+ description: returns network-profile
+ operationId: getCloudInfrastructureNetworkProfilesNetworkProfile
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/network-profile"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: nm-profile-name
+ in: path
+ description: Unique name of network profile.
+ required: true
+ type: string
+ example: __NM-PROFILE-NAME__
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing network-profile
+ description: |
+ Create or update an existing network-profile.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfile
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: nm-profile-name
+ in: path
+ description: Unique name of network profile.
+ required: true
+ type: string
+ example: __NM-PROFILE-NAME__
+ - name: body
+ in: body
+ description: network-profile object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureNetworkProfilesNetworkProfile.json)
+ required: true
+ schema:
+ $ref: "#/definitions/network-profile"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing network-profile
+ description: |
+ Update an existing network-profile
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructureNetworkProfilesNetworkProfile
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: nm-profile-name
+ in: path
+ description: Unique name of network profile.
+ required: true
+ type: string
+ example: __NM-PROFILE-NAME__
+ - name: body
+ in: body
+ description: network-profile object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/network-profile"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing network-profile
+ description: delete an existing network-profile
+ operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfile
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: nm-profile-name
+ in: path
+ description: Unique name of network profile.
+ required: true
+ type: string
+ example: __NM-PROFILE-NAME__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /cloud-infrastructure/network-profiles:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns network-profiles
+ description: returns network-profiles
+ operationId: getCloudInfrastructureNetworkProfiles
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/network-profiles"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship:
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructurePserversPserverRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserver.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructurePserversPserverRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterface.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship:
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pf-pci-id
+ in: path
+ description: Identifier for the sriov-pf
+ required: true
+ type: string
+ example: __PF-PCI-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pf-pci-id
+ in: path
+ description: Identifier for the sriov-pf
+ required: true
+ type: string
+ example: __PF-PCI-ID__
+ /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns sriov-pf
+ description: returns sriov-pf
+ operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/sriov-pf"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pf-pci-id
+ in: path
+ description: Identifier for the sriov-pf
+ required: true
+ type: string
+ example: __PF-PCI-ID__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: pserver-id
+ in: query
+ description: ID of Pserver
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: pserver-name2
+ in: query
+ description: alternative pserver name
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing sriov-pf
+ description: |
+ Create or update an existing sriov-pf.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pf-pci-id
+ in: path
+ description: Identifier for the sriov-pf
+ required: true
+ type: string
+ example: __PF-PCI-ID__
+ - name: body
+ in: body
+ description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf.json)
+ required: true
+ schema:
+ $ref: "#/definitions/sriov-pf"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing sriov-pf
+ description: |
+ Update an existing sriov-pf
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pf-pci-id
+ in: path
+ description: Identifier for the sriov-pf
+ required: true
+ type: string
+ example: __PF-PCI-ID__
+ - name: body
+ in: body
+ description: sriov-pf object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/sriov-pf"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing sriov-pf
+ description: delete an existing sriov-pf
+ operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pf-pci-id
+ in: path
+ description: Identifier for the sriov-pf
+ required: true
+ type: string
+ example: __PF-PCI-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns sriov-pfs
+ description: returns sriov-pfs
+ operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfs
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/sriov-pfs"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: pserver-id
+ in: query
+ description: ID of Pserver
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: pserver-name2
+ in: query
+ description: alternative pserver name
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ /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:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ /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:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ /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:
+ tags:
+ - CloudInfrastructure
+ summary: returns l3-interface-ipv4-address-list
+ description: returns l3-interface-ipv4-address-list
+ operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: pserver-id
+ in: query
+ description: ID of Pserver
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: pserver-name2
+ in: query
+ description: alternative pserver name
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: vpn-key
+ in: query
+ description: This indicates the customers VPN ID associated with this vlan
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface that address belongs to
+ required: false
+ type: string
+ - name: neutron-subnet-id
+ in: query
+ description: Neutron id of subnet that address belongs to
+ required: false
+ type: string
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing l3-interface-ipv4-address-list
+ description: |
+ Create or update an existing l3-interface-ipv4-address-list.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv4-address-list"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing l3-interface-ipv4-address-list
+ description: |
+ Update an existing l3-interface-ipv4-address-list
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing l3-interface-ipv4-address-list
+ description: delete an existing l3-interface-ipv4-address-list
+ operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /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:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ /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:
+ tags:
+ - CloudInfrastructure
+ summary: returns l3-interface-ipv6-address-list
+ description: returns l3-interface-ipv6-address-list
+ operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: pserver-id
+ in: query
+ description: ID of Pserver
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: pserver-name2
+ in: query
+ description: alternative pserver name
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: vpn-key
+ in: query
+ description: This indicates the customers VPN ID associated with this vlan
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface that address belongs to
+ required: false
+ type: string
+ - name: neutron-subnet-id
+ in: query
+ description: Neutron id of subnet that address belongs to
+ required: false
+ type: string
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing l3-interface-ipv6-address-list
+ description: |
+ Create or update an existing l3-interface-ipv6-address-list.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing l3-interface-ipv6-address-list
+ description: |
+ Update an existing l3-interface-ipv6-address-list
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing l3-interface-ipv6-address-list
+ description: delete an existing l3-interface-ipv6-address-list
+ operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns vlan
+ description: returns vlan
+ operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/vlan"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: pserver-id
+ in: query
+ description: ID of Pserver
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: pserver-name2
+ in: query
+ description: alternative pserver name
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: vpn-key
+ in: query
+ description: This indicates the customers VPN ID associated with this vlan
+ required: false
+ type: string
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing vlan
+ description: |
+ Create or update an existing vlan.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: body
+ in: body
+ description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
+ required: true
+ schema:
+ $ref: "#/definitions/vlan"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing vlan
+ description: |
+ Update an existing vlan
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: body
+ in: body
+ description: vlan object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/vlan"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing vlan
+ description: delete an existing vlan
+ operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns vlans
+ description: returns vlans
+ operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlans
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/vlans"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: pserver-id
+ in: query
+ description: ID of Pserver
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: pserver-name2
+ in: query
+ description: alternative pserver name
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ /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:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns sriov-vf
+ description: returns sriov-vf
+ operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/sriov-vf"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: pserver-id
+ in: query
+ description: ID of Pserver
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: pserver-name2
+ in: query
+ description: alternative pserver name
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vf-vlan-filter
+ in: query
+ description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
+ required: false
+ type: string
+ - name: vf-mac-filter
+ in: query
+ description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
+ required: false
+ type: string
+ - name: vf-vlan-strip
+ in: query
+ description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
+ required: false
+ type: boolean
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface
+ required: false
+ type: string
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing sriov-vf
+ description: |
+ Create or update an existing sriov-vf.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: body
+ in: body
+ description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
+ required: true
+ schema:
+ $ref: "#/definitions/sriov-vf"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing sriov-vf
+ description: |
+ Update an existing sriov-vf
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: body
+ in: body
+ description: sriov-vf object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/sriov-vf"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing sriov-vf
+ description: delete an existing sriov-vf
+ operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns sriov-vfs
+ description: returns sriov-vfs
+ operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/sriov-vfs"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: pserver-id
+ in: query
+ description: ID of Pserver
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: pserver-name2
+ in: query
+ description: alternative pserver name
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ /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:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ /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:
+ tags:
+ - CloudInfrastructure
+ summary: returns l3-interface-ipv4-address-list
+ description: returns l3-interface-ipv4-address-list
+ operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: pserver-id
+ in: query
+ description: ID of Pserver
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: pserver-name2
+ in: query
+ description: alternative pserver name
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface that address belongs to
+ required: false
+ type: string
+ - name: neutron-subnet-id
+ in: query
+ description: Neutron id of subnet that address belongs to
+ required: false
+ type: string
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing l3-interface-ipv4-address-list
+ description: |
+ Create or update an existing l3-interface-ipv4-address-list.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv4-address-list"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing l3-interface-ipv4-address-list
+ description: |
+ Update an existing l3-interface-ipv4-address-list
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing l3-interface-ipv4-address-list
+ description: delete an existing l3-interface-ipv4-address-list
+ operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /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:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ /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:
+ tags:
+ - CloudInfrastructure
+ summary: returns l3-interface-ipv6-address-list
+ description: returns l3-interface-ipv6-address-list
+ operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: pserver-id
+ in: query
+ description: ID of Pserver
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: pserver-name2
+ in: query
+ description: alternative pserver name
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface that address belongs to
+ required: false
+ type: string
+ - name: neutron-subnet-id
+ in: query
+ description: Neutron id of subnet that address belongs to
+ required: false
+ type: string
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing l3-interface-ipv6-address-list
+ description: |
+ Create or update an existing l3-interface-ipv6-address-list.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing l3-interface-ipv6-address-list
+ description: |
+ Update an existing l3-interface-ipv6-address-list
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing l3-interface-ipv6-address-list
+ description: delete an existing l3-interface-ipv6-address-list
+ operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns l-interface
+ description: returns l-interface
+ operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l-interface"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: pserver-id
+ in: query
+ description: ID of Pserver
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: pserver-name2
+ in: query
+ description: alternative pserver name
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing l-interface
+ description: |
+ Create or update an existing l-interface.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l-interface"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing l-interface
+ description: |
+ Update an existing l-interface
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: l-interface object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l-interface"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing l-interface
+ description: delete an existing l-interface
+ operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns l-interfaces
+ description: returns l-interfaces
+ operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfaces
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l-interfaces"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: pserver-id
+ in: query
+ description: ID of Pserver
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: pserver-name2
+ in: query
+ description: alternative pserver name
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns p-interface
+ description: returns p-interface
+ operationId: getCloudInfrastructurePserversPserverPInterfacesPInterface
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/p-interface"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: pserver-id
+ in: query
+ description: ID of Pserver
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: pserver-name2
+ in: query
+ description: alternative pserver name
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing p-interface
+ description: |
+ Create or update an existing p-interface.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterface.json)
+ required: true
+ schema:
+ $ref: "#/definitions/p-interface"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing p-interface
+ description: |
+ Update an existing p-interface
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: p-interface object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/p-interface"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing p-interface
+ description: delete an existing p-interface
+ operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns p-interfaces
+ description: returns p-interfaces
+ operationId: getCloudInfrastructurePserversPserverPInterfaces
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/p-interfaces"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: pserver-id
+ in: query
+ description: ID of Pserver
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: pserver-name2
+ in: query
+ description: alternative pserver name
+ required: false
+ type: string
+ /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ /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:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ /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:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ /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:
+ tags:
+ - CloudInfrastructure
+ summary: returns l3-interface-ipv4-address-list
+ description: returns l3-interface-ipv4-address-list
+ operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: pserver-id
+ in: query
+ description: ID of Pserver
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: pserver-name2
+ in: query
+ description: alternative pserver name
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: vpn-key
+ in: query
+ description: This indicates the customers VPN ID associated with this vlan
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface that address belongs to
+ required: false
+ type: string
+ - name: neutron-subnet-id
+ in: query
+ description: Neutron id of subnet that address belongs to
+ required: false
+ type: string
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing l3-interface-ipv4-address-list
+ description: |
+ Create or update an existing l3-interface-ipv4-address-list.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv4-address-list"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing l3-interface-ipv4-address-list
+ description: |
+ Update an existing l3-interface-ipv4-address-list
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing l3-interface-ipv4-address-list
+ description: delete an existing l3-interface-ipv4-address-list
+ operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /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:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ /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:
+ tags:
+ - CloudInfrastructure
+ summary: returns l3-interface-ipv6-address-list
+ description: returns l3-interface-ipv6-address-list
+ operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: pserver-id
+ in: query
+ description: ID of Pserver
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: pserver-name2
+ in: query
+ description: alternative pserver name
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: vpn-key
+ in: query
+ description: This indicates the customers VPN ID associated with this vlan
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface that address belongs to
+ required: false
+ type: string
+ - name: neutron-subnet-id
+ in: query
+ description: Neutron id of subnet that address belongs to
+ required: false
+ type: string
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing l3-interface-ipv6-address-list
+ description: |
+ Create or update an existing l3-interface-ipv6-address-list.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing l3-interface-ipv6-address-list
+ description: |
+ Update an existing l3-interface-ipv6-address-list
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing l3-interface-ipv6-address-list
+ description: delete an existing l3-interface-ipv6-address-list
+ operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns vlan
+ description: returns vlan
+ operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/vlan"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: pserver-id
+ in: query
+ description: ID of Pserver
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: pserver-name2
+ in: query
+ description: alternative pserver name
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: vpn-key
+ in: query
+ description: This indicates the customers VPN ID associated with this vlan
+ required: false
+ type: string
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing vlan
+ description: |
+ Create or update an existing vlan.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: body
+ in: body
+ description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
+ required: true
+ schema:
+ $ref: "#/definitions/vlan"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing vlan
+ description: |
+ Update an existing vlan
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: body
+ in: body
+ description: vlan object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/vlan"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing vlan
+ description: delete an existing vlan
+ operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns vlans
+ description: returns vlans
+ operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/vlans"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: pserver-id
+ in: query
+ description: ID of Pserver
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: pserver-name2
+ in: query
+ description: alternative pserver name
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ /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:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns sriov-vf
+ description: returns sriov-vf
+ operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/sriov-vf"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: pserver-id
+ in: query
+ description: ID of Pserver
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: pserver-name2
+ in: query
+ description: alternative pserver name
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vf-vlan-filter
+ in: query
+ description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
+ required: false
+ type: string
+ - name: vf-mac-filter
+ in: query
+ description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
+ required: false
+ type: string
+ - name: vf-vlan-strip
+ in: query
+ description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
+ required: false
+ type: boolean
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface
+ required: false
+ type: string
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing sriov-vf
+ description: |
+ Create or update an existing sriov-vf.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: body
+ in: body
+ description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
+ required: true
+ schema:
+ $ref: "#/definitions/sriov-vf"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing sriov-vf
+ description: |
+ Update an existing sriov-vf
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: body
+ in: body
+ description: sriov-vf object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/sriov-vf"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing sriov-vf
+ description: delete an existing sriov-vf
+ operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns sriov-vfs
+ description: returns sriov-vfs
+ operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/sriov-vfs"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: pserver-id
+ in: query
+ description: ID of Pserver
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: pserver-name2
+ in: query
+ description: alternative pserver name
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ /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:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ /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:
+ tags:
+ - CloudInfrastructure
+ summary: returns l3-interface-ipv4-address-list
+ description: returns l3-interface-ipv4-address-list
+ operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: pserver-id
+ in: query
+ description: ID of Pserver
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: pserver-name2
+ in: query
+ description: alternative pserver name
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface that address belongs to
+ required: false
+ type: string
+ - name: neutron-subnet-id
+ in: query
+ description: Neutron id of subnet that address belongs to
+ required: false
+ type: string
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing l3-interface-ipv4-address-list
+ description: |
+ Create or update an existing l3-interface-ipv4-address-list.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv4-address-list"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing l3-interface-ipv4-address-list
+ description: |
+ Update an existing l3-interface-ipv4-address-list
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing l3-interface-ipv4-address-list
+ description: delete an existing l3-interface-ipv4-address-list
+ operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /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:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ /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:
+ tags:
+ - CloudInfrastructure
+ summary: returns l3-interface-ipv6-address-list
+ description: returns l3-interface-ipv6-address-list
+ operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: pserver-id
+ in: query
+ description: ID of Pserver
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: pserver-name2
+ in: query
+ description: alternative pserver name
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface that address belongs to
+ required: false
+ type: string
+ - name: neutron-subnet-id
+ in: query
+ description: Neutron id of subnet that address belongs to
+ required: false
+ type: string
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing l3-interface-ipv6-address-list
+ description: |
+ Create or update an existing l3-interface-ipv6-address-list.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing l3-interface-ipv6-address-list
+ description: |
+ Update an existing l3-interface-ipv6-address-list
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing l3-interface-ipv6-address-list
+ description: delete an existing l3-interface-ipv6-address-list
+ operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns l-interface
+ description: returns l-interface
+ operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l-interface"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: pserver-id
+ in: query
+ description: ID of Pserver
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: pserver-name2
+ in: query
+ description: alternative pserver name
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing l-interface
+ description: |
+ Create or update an existing l-interface.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l-interface"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing l-interface
+ description: |
+ Update an existing l-interface
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: l-interface object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l-interface"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing l-interface
+ description: delete an existing l-interface
+ operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns l-interfaces
+ description: returns l-interfaces
+ operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfaces
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l-interfaces"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: pserver-id
+ in: query
+ description: ID of Pserver
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: pserver-name2
+ in: query
+ description: alternative pserver name
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ required: false
+ type: string
+ /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns lag-interface
+ description: returns lag-interface
+ operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterface
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/lag-interface"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: pserver-id
+ in: query
+ description: ID of Pserver
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: pserver-name2
+ in: query
+ description: alternative pserver name
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ required: false
+ type: string
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing lag-interface
+ description: |
+ Create or update an existing lag-interface.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
+ required: true
+ schema:
+ $ref: "#/definitions/lag-interface"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing lag-interface
+ description: |
+ Update an existing lag-interface
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: lag-interface object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/lag-interface"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing lag-interface
+ description: delete an existing lag-interface
+ operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns lag-interfaces
+ description: returns lag-interfaces
+ operationId: getCloudInfrastructurePserversPserverLagInterfaces
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/lag-interfaces"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: pserver-id
+ in: query
+ description: ID of Pserver
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: pserver-name2
+ in: query
+ description: alternative pserver name
+ required: false
+ type: string
+ /cloud-infrastructure/pservers/pserver/{hostname}:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns pserver
+ description: returns pserver
+ operationId: getCloudInfrastructurePserversPserver
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/pserver"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: pserver-id
+ in: query
+ description: ID of Pserver
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: pserver-name2
+ in: query
+ description: alternative pserver name
+ required: false
+ type: string
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing pserver
+ description: |
+ Create or update an existing pserver.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructurePserversPserver
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: body
+ in: body
+ description: pserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserver.json)
+ required: true
+ schema:
+ $ref: "#/definitions/pserver"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing pserver
+ description: |
+ Update an existing pserver
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructurePserversPserver
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: body
+ in: body
+ description: pserver object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/pserver"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing pserver
+ description: delete an existing pserver
+ operationId: deleteCloudInfrastructurePserversPserver
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: hostname
+ in: path
+ description: Value from executing hostname on the compute node.
+ required: true
+ type: string
+ example: __HOSTNAME__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /cloud-infrastructure/pservers:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns pservers
+ description: returns pservers
+ operationId: getCloudInfrastructurePservers
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/pservers"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship:
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vdc-id
+ in: path
+ description: Unique ID of the vdc
+ required: true
+ type: string
+ example: __VDC-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vdc-id
+ in: path
+ description: Unique ID of the vdc
+ required: true
+ type: string
+ example: __VDC-ID__
+ /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns virtual-data-center
+ description: returns virtual-data-center
+ operationId: getCloudInfrastructureVirtualDataCentersVirtualDataCenter
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/virtual-data-center"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vdc-id
+ in: path
+ description: Unique ID of the vdc
+ required: true
+ type: string
+ example: __VDC-ID__
+ - name: vdc-name
+ in: query
+ description: Name of the virtual data center
+ required: false
+ type: string
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing virtual-data-center
+ description: |
+ Create or update an existing virtual-data-center.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vdc-id
+ in: path
+ description: Unique ID of the vdc
+ required: true
+ type: string
+ example: __VDC-ID__
+ - name: body
+ in: body
+ description: virtual-data-center object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
+ required: true
+ schema:
+ $ref: "#/definitions/virtual-data-center"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing virtual-data-center
+ description: |
+ Update an existing virtual-data-center
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vdc-id
+ in: path
+ description: Unique ID of the vdc
+ required: true
+ type: string
+ example: __VDC-ID__
+ - name: body
+ in: body
+ description: virtual-data-center object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/virtual-data-center"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing virtual-data-center
+ description: delete an existing virtual-data-center
+ operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenter
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vdc-id
+ in: path
+ description: Unique ID of the vdc
+ required: true
+ type: string
+ example: __VDC-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /cloud-infrastructure/virtual-data-centers:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns virtual-data-centers
+ description: returns virtual-data-centers
+ operationId: getCloudInfrastructureVirtualDataCenters
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/virtual-data-centers"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}/relationship-list/relationship:
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructureOperationalEnvironmentsOperationalEnvironmentRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: operational-environment-id
+ in: path
+ description: UUID of an operational environment
+ required: true
+ type: string
+ example: __OPERATIONAL-ENVIRONMENT-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureOperationalEnvironmentsOperationalEnvironment.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructureOperationalEnvironmentsOperationalEnvironmentRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: operational-environment-id
+ in: path
+ description: UUID of an operational environment
+ required: true
+ type: string
+ example: __OPERATIONAL-ENVIRONMENT-ID__
+ /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns operational-environment
+ description: returns operational-environment
+ operationId: getCloudInfrastructureOperationalEnvironmentsOperationalEnvironment
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/operational-environment"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: operational-environment-id
+ in: path
+ description: UUID of an operational environment
+ required: true
+ type: string
+ example: __OPERATIONAL-ENVIRONMENT-ID__
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing operational-environment
+ description: |
+ Create or update an existing operational-environment.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateCloudInfrastructureOperationalEnvironmentsOperationalEnvironment
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: operational-environment-id
+ in: path
+ description: UUID of an operational environment
+ required: true
+ type: string
+ example: __OPERATIONAL-ENVIRONMENT-ID__
+ - name: body
+ in: body
+ description: operational-environment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureOperationalEnvironmentsOperationalEnvironment.json)
+ required: true
+ schema:
+ $ref: "#/definitions/operational-environment"
+ patch:
+ tags:
+ - CloudInfrastructure
+ summary: update an existing operational-environment
+ description: |
+ Update an existing operational-environment
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateCloudInfrastructureOperationalEnvironmentsOperationalEnvironment
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: operational-environment-id
+ in: path
+ description: UUID of an operational environment
+ required: true
+ type: string
+ example: __OPERATIONAL-ENVIRONMENT-ID__
+ - name: body
+ in: body
+ description: operational-environment object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/operational-environment"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing operational-environment
+ description: delete an existing operational-environment
+ operationId: deleteCloudInfrastructureOperationalEnvironmentsOperationalEnvironment
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: operational-environment-id
+ in: path
+ description: UUID of an operational environment
+ required: true
+ type: string
+ example: __OPERATIONAL-ENVIRONMENT-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /cloud-infrastructure/operational-environments:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns operational-environments
+ description: returns operational-environments
+ operationId: getCloudInfrastructureOperationalEnvironments
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/operational-environments"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /business/connectors/connector/{resource-instance-id}/relationship-list/relationship:
+ put:
+ tags:
+ - Business
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateBusinessConnectorsConnectorRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: resource-instance-id
+ in: path
+ description: Unique id of resource instance.
+ required: true
+ type: string
+ example: __RESOURCE-INSTANCE-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessConnectorsConnector.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Business
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteBusinessConnectorsConnectorRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: resource-instance-id
+ in: path
+ description: Unique id of resource instance.
+ required: true
+ type: string
+ example: __RESOURCE-INSTANCE-ID__
+ /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}:
+ get:
+ tags:
+ - Business
+ summary: returns metadatum
+ description: returns metadatum
+ operationId: getBusinessConnectorsConnectorMetadataMetadatum
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/metadatum"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: resource-instance-id
+ in: path
+ description: Unique id of resource instance.
+ required: true
+ type: string
+ example: __RESOURCE-INSTANCE-ID__
+ - name: metaname
+ in: path
+ required: true
+ type: string
+ example: __METANAME__
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ put:
+ tags:
+ - Business
+ summary: create or update an existing metadatum
+ description: |
+ Create or update an existing metadatum.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateBusinessConnectorsConnectorMetadataMetadatum
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: resource-instance-id
+ in: path
+ description: Unique id of resource instance.
+ required: true
+ type: string
+ example: __RESOURCE-INSTANCE-ID__
+ - name: metaname
+ in: path
+ required: true
+ type: string
+ example: __METANAME__
+ - name: body
+ in: body
+ description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessConnectorsConnectorMetadataMetadatum.json)
+ required: true
+ schema:
+ $ref: "#/definitions/metadatum"
+ patch:
+ tags:
+ - Business
+ summary: update an existing metadatum
+ description: |
+ Update an existing metadatum
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateBusinessConnectorsConnectorMetadataMetadatum
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: resource-instance-id
+ in: path
+ description: Unique id of resource instance.
+ required: true
+ type: string
+ example: __RESOURCE-INSTANCE-ID__
+ - name: metaname
+ in: path
+ required: true
+ type: string
+ example: __METANAME__
+ - name: body
+ in: body
+ description: metadatum object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/metadatum"
+ delete:
+ tags:
+ - Business
+ summary: delete an existing metadatum
+ description: delete an existing metadatum
+ operationId: deleteBusinessConnectorsConnectorMetadataMetadatum
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: resource-instance-id
+ in: path
+ description: Unique id of resource instance.
+ required: true
+ type: string
+ example: __RESOURCE-INSTANCE-ID__
+ - name: metaname
+ in: path
+ required: true
+ type: string
+ example: __METANAME__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /business/connectors/connector/{resource-instance-id}/metadata:
+ get:
+ tags:
+ - Business
+ summary: returns metadata
+ description: returns metadata
+ operationId: getBusinessConnectorsConnectorMetadata
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/metadata"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: resource-instance-id
+ in: path
+ description: Unique id of resource instance.
+ required: true
+ type: string
+ example: __RESOURCE-INSTANCE-ID__
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ /business/connectors/connector/{resource-instance-id}:
+ get:
+ tags:
+ - Business
+ summary: returns connector
+ description: returns connector
+ operationId: getBusinessConnectorsConnector
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/connector"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: resource-instance-id
+ in: path
+ description: Unique id of resource instance.
+ required: true
+ type: string
+ example: __RESOURCE-INSTANCE-ID__
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ put:
+ tags:
+ - Business
+ summary: create or update an existing connector
+ description: |
+ Create or update an existing connector.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateBusinessConnectorsConnector
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: resource-instance-id
+ in: path
+ description: Unique id of resource instance.
+ required: true
+ type: string
+ example: __RESOURCE-INSTANCE-ID__
+ - name: body
+ in: body
+ description: connector object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessConnectorsConnector.json)
+ required: true
+ schema:
+ $ref: "#/definitions/connector"
+ patch:
+ tags:
+ - Business
+ summary: update an existing connector
+ description: |
+ Update an existing connector
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateBusinessConnectorsConnector
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: resource-instance-id
+ in: path
+ description: Unique id of resource instance.
+ required: true
+ type: string
+ example: __RESOURCE-INSTANCE-ID__
+ - name: body
+ in: body
+ description: connector object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/connector"
+ delete:
+ tags:
+ - Business
+ summary: delete an existing connector
+ description: delete an existing connector
+ operationId: deleteBusinessConnectorsConnector
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: resource-instance-id
+ in: path
+ description: Unique id of resource instance.
+ required: true
+ type: string
+ example: __RESOURCE-INSTANCE-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /business/connectors:
+ get:
+ tags:
+ - Business
+ summary: returns connectors
+ description: returns connectors
+ operationId: getBusinessConnectors
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/connectors"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship:
+ put:
+ tags:
+ - Business
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ example: __GLOBAL-CUSTOMER-ID__
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
+ type: string
+ example: __SERVICE-TYPE__
+ - name: service-instance-id
+ in: path
+ description: Uniquely identifies this instance of a service
+ required: true
+ type: string
+ example: __SERVICE-INSTANCE-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Business
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ example: __GLOBAL-CUSTOMER-ID__
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
+ type: string
+ example: __SERVICE-TYPE__
+ - name: service-instance-id
+ in: path
+ description: Uniquely identifies this instance of a service
+ required: true
+ type: string
+ example: __SERVICE-INSTANCE-ID__
+ /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}:
+ get:
+ tags:
+ - Business
+ summary: returns metadatum
+ description: returns metadatum
+ operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/metadatum"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ example: __GLOBAL-CUSTOMER-ID__
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
+ type: string
+ example: __SERVICE-TYPE__
+ - name: service-instance-id
+ in: path
+ description: Uniquely identifies this instance of a service
+ required: true
+ type: string
+ example: __SERVICE-INSTANCE-ID__
+ - name: metaname
+ in: path
+ required: true
+ type: string
+ example: __METANAME__
+ - name: subscriber-name
+ in: query
+ description: Subscriber name, an alternate way to retrieve a customer.
+ required: false
+ type: string
+ - name: subscriber-type
+ in: query
+ description: Subscriber type, a way to provide VID with only the INFRA customers.
+ required: false
+ type: string
+ - name: service-instance-name
+ in: query
+ description: This field will store a name assigned to the service-instance.
+ required: false
+ type: string
+ - name: environment-context
+ in: query
+ description: This field will store the environment context assigned to the service-instance.
+ required: false
+ type: string
+ - name: workload-context
+ in: query
+ description: This field will store the workload context assigned to the service-instance.
+ required: false
+ type: string
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ - name: service-instance-location-id
+ in: query
+ description: An identifier that customers assign to the location where this service is being used.
+ required: false
+ type: string
+ - name: orchestration-status
+ in: query
+ description: Orchestration status of this service.
+ required: false
+ type: string
+ put:
+ tags:
+ - Business
+ summary: create or update an existing metadatum
+ description: |
+ Create or update an existing metadatum.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ example: __GLOBAL-CUSTOMER-ID__
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
+ type: string
+ example: __SERVICE-TYPE__
+ - name: service-instance-id
+ in: path
+ description: Uniquely identifies this instance of a service
+ required: true
+ type: string
+ example: __SERVICE-INSTANCE-ID__
+ - name: metaname
+ in: path
+ required: true
+ type: string
+ example: __METANAME__
+ - name: body
+ in: body
+ description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum.json)
+ required: true
+ schema:
+ $ref: "#/definitions/metadatum"
+ patch:
+ tags:
+ - Business
+ summary: update an existing metadatum
+ description: |
+ Update an existing metadatum
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ example: __GLOBAL-CUSTOMER-ID__
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
+ type: string
+ example: __SERVICE-TYPE__
+ - name: service-instance-id
+ in: path
+ description: Uniquely identifies this instance of a service
+ required: true
+ type: string
+ example: __SERVICE-INSTANCE-ID__
+ - name: metaname
+ in: path
+ required: true
+ type: string
+ example: __METANAME__
+ - name: body
+ in: body
+ description: metadatum object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/metadatum"
+ delete:
+ tags:
+ - Business
+ summary: delete an existing metadatum
+ description: delete an existing metadatum
+ operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ example: __GLOBAL-CUSTOMER-ID__
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
+ type: string
+ example: __SERVICE-TYPE__
+ - name: service-instance-id
+ in: path
+ description: Uniquely identifies this instance of a service
+ required: true
+ type: string
+ example: __SERVICE-INSTANCE-ID__
+ - name: metaname
+ in: path
+ required: true
+ type: string
+ example: __METANAME__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata:
+ get:
+ tags:
+ - Business
+ summary: returns metadata
+ description: returns metadata
+ operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadata
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/metadata"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ example: __GLOBAL-CUSTOMER-ID__
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
+ type: string
+ example: __SERVICE-TYPE__
+ - name: service-instance-id
+ in: path
+ description: Uniquely identifies this instance of a service
+ required: true
+ type: string
+ example: __SERVICE-INSTANCE-ID__
+ - name: subscriber-name
+ in: query
+ description: Subscriber name, an alternate way to retrieve a customer.
+ required: false
+ type: string
+ - name: subscriber-type
+ in: query
+ description: Subscriber type, a way to provide VID with only the INFRA customers.
+ required: false
+ type: string
+ - name: service-instance-name
+ in: query
+ description: This field will store a name assigned to the service-instance.
+ required: false
+ type: string
+ - name: environment-context
+ in: query
+ description: This field will store the environment context assigned to the service-instance.
+ required: false
+ type: string
+ - name: workload-context
+ in: query
+ description: This field will store the workload context assigned to the service-instance.
+ required: false
+ type: string
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ - name: service-instance-location-id
+ in: query
+ description: An identifier that customers assign to the location where this service is being used.
+ required: false
+ type: string
+ - name: orchestration-status
+ in: query
+ description: Orchestration status of this service.
+ required: false
+ type: string
+ /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:
+ tags:
+ - Business
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ example: __GLOBAL-CUSTOMER-ID__
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
+ type: string
+ example: __SERVICE-TYPE__
+ - name: service-instance-id
+ in: path
+ description: Uniquely identifies this instance of a service
+ required: true
+ type: string
+ example: __SERVICE-INSTANCE-ID__
+ - name: id
+ in: path
+ description: Allotted Resource id UUID assigned to this instance.
+ required: true
+ type: string
+ example: __ID__
+ - name: id
+ in: path
+ description: Allotted Resource id UUID assigned to this instance.
+ required: true
+ type: string
+ example: __ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Business
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ example: __GLOBAL-CUSTOMER-ID__
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
+ type: string
+ example: __SERVICE-TYPE__
+ - name: service-instance-id
+ in: path
+ description: Uniquely identifies this instance of a service
+ required: true
+ type: string
+ example: __SERVICE-INSTANCE-ID__
+ - name: id
+ in: path
+ description: Allotted Resource id UUID assigned to this instance.
+ required: true
+ type: string
+ example: __ID__
+ - name: id
+ in: path
+ description: Allotted Resource id UUID assigned to this instance.
+ required: true
+ type: string
+ example: __ID__
+ /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:
+ tags:
+ - Business
+ summary: returns tunnel-xconnect
+ description: returns tunnel-xconnect
+ operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/tunnel-xconnect"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ example: __GLOBAL-CUSTOMER-ID__
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
+ type: string
+ example: __SERVICE-TYPE__
+ - name: service-instance-id
+ in: path
+ description: Uniquely identifies this instance of a service
+ required: true
+ type: string
+ example: __SERVICE-INSTANCE-ID__
+ - name: id
+ in: path
+ description: Allotted Resource id UUID assigned to this instance.
+ required: true
+ type: string
+ example: __ID__
+ - name: id
+ in: path
+ description: Allotted Resource id UUID assigned to this instance.
+ required: true
+ type: string
+ example: __ID__
+ - name: subscriber-name
+ in: query
+ description: Subscriber name, an alternate way to retrieve a customer.
+ required: false
+ type: string
+ - name: subscriber-type
+ in: query
+ description: Subscriber type, a way to provide VID with only the INFRA customers.
+ required: false
+ type: string
+ - name: service-instance-name
+ in: query
+ description: This field will store a name assigned to the service-instance.
+ required: false
+ type: string
+ - name: environment-context
+ in: query
+ description: This field will store the environment context assigned to the service-instance.
+ required: false
+ type: string
+ - name: workload-context
+ in: query
+ description: This field will store the workload context assigned to the service-instance.
+ required: false
+ type: string
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ - name: service-instance-location-id
+ in: query
+ description: An identifier that customers assign to the location where this service is being used.
+ required: false
+ type: string
+ - name: orchestration-status
+ in: query
+ description: Orchestration status of this service.
+ required: false
+ type: string
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: type
+ in: query
+ description: Generic description of the type of allotted resource.
+ required: false
+ type: string
+ - name: role
+ in: query
+ description: role in the network that this resource will be providing.
+ required: false
+ type: string
+ put:
+ tags:
+ - Business
+ summary: create or update an existing tunnel-xconnect
+ description: |
+ Create or update an existing tunnel-xconnect.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ example: __GLOBAL-CUSTOMER-ID__
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
+ type: string
+ example: __SERVICE-TYPE__
+ - name: service-instance-id
+ in: path
+ description: Uniquely identifies this instance of a service
+ required: true
+ type: string
+ example: __SERVICE-INSTANCE-ID__
+ - name: id
+ in: path
+ description: Allotted Resource id UUID assigned to this instance.
+ required: true
+ type: string
+ example: __ID__
+ - name: id
+ in: path
+ description: Allotted Resource id UUID assigned to this instance.
+ required: true
+ type: string
+ example: __ID__
+ - name: body
+ in: body
+ description: tunnel-xconnect object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)
+ required: true
+ schema:
+ $ref: "#/definitions/tunnel-xconnect"
+ patch:
+ tags:
+ - Business
+ summary: update an existing tunnel-xconnect
+ description: |
+ Update an existing tunnel-xconnect
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ example: __GLOBAL-CUSTOMER-ID__
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
+ type: string
+ example: __SERVICE-TYPE__
+ - name: service-instance-id
+ in: path
+ description: Uniquely identifies this instance of a service
+ required: true
+ type: string
+ example: __SERVICE-INSTANCE-ID__
+ - name: id
+ in: path
+ description: Allotted Resource id UUID assigned to this instance.
+ required: true
+ type: string
+ example: __ID__
+ - name: id
+ in: path
+ description: Allotted Resource id UUID assigned to this instance.
+ required: true
+ type: string
+ example: __ID__
+ - name: body
+ in: body
+ description: tunnel-xconnect object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/tunnel-xconnect"
+ delete:
+ tags:
+ - Business
+ summary: delete an existing tunnel-xconnect
+ description: delete an existing tunnel-xconnect
+ operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ example: __GLOBAL-CUSTOMER-ID__
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
+ type: string
+ example: __SERVICE-TYPE__
+ - name: service-instance-id
+ in: path
+ description: Uniquely identifies this instance of a service
+ required: true
+ type: string
+ example: __SERVICE-INSTANCE-ID__
+ - name: id
+ in: path
+ description: Allotted Resource id UUID assigned to this instance.
+ required: true
+ type: string
+ example: __ID__
+ - name: id
+ in: path
+ description: Allotted Resource id UUID assigned to this instance.
+ required: true
+ type: string
+ example: __ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /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:
+ tags:
+ - Business
+ summary: returns tunnel-xconnects
+ description: returns tunnel-xconnects
+ operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnects
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/tunnel-xconnects"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ example: __GLOBAL-CUSTOMER-ID__
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
+ type: string
+ example: __SERVICE-TYPE__
+ - name: service-instance-id
+ in: path
+ description: Uniquely identifies this instance of a service
+ required: true
+ type: string
+ example: __SERVICE-INSTANCE-ID__
+ - name: id
+ in: path
+ description: Allotted Resource id UUID assigned to this instance.
+ required: true
+ type: string
+ example: __ID__
+ - name: subscriber-name
+ in: query
+ description: Subscriber name, an alternate way to retrieve a customer.
+ required: false
+ type: string
+ - name: subscriber-type
+ in: query
+ description: Subscriber type, a way to provide VID with only the INFRA customers.
+ required: false
+ type: string
+ - name: service-instance-name
+ in: query
+ description: This field will store a name assigned to the service-instance.
+ required: false
+ type: string
+ - name: environment-context
+ in: query
+ description: This field will store the environment context assigned to the service-instance.
+ required: false
+ type: string
+ - name: workload-context
+ in: query
+ description: This field will store the workload context assigned to the service-instance.
+ required: false
+ type: string
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ - name: service-instance-location-id
+ in: query
+ description: An identifier that customers assign to the location where this service is being used.
+ required: false
+ type: string
+ - name: orchestration-status
+ in: query
+ description: Orchestration status of this service.
+ required: false
+ type: string
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: type
+ in: query
+ description: Generic description of the type of allotted resource.
+ required: false
+ type: string
+ - name: role
+ in: query
+ description: role in the network that this resource will be providing.
+ required: false
+ type: string
+ /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:
+ tags:
+ - Business
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ example: __GLOBAL-CUSTOMER-ID__
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
+ type: string
+ example: __SERVICE-TYPE__
+ - name: service-instance-id
+ in: path
+ description: Uniquely identifies this instance of a service
+ required: true
+ type: string
+ example: __SERVICE-INSTANCE-ID__
+ - name: id
+ in: path
+ description: Allotted Resource id UUID assigned to this instance.
+ required: true
+ type: string
+ example: __ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Business
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ example: __GLOBAL-CUSTOMER-ID__
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
+ type: string
+ example: __SERVICE-TYPE__
+ - name: service-instance-id
+ in: path
+ description: Uniquely identifies this instance of a service
+ required: true
+ type: string
+ example: __SERVICE-INSTANCE-ID__
+ - name: id
+ in: path
+ description: Allotted Resource id UUID assigned to this instance.
+ required: true
+ type: string
+ example: __ID__
+ /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:
+ tags:
+ - Business
+ summary: returns allotted-resource
+ description: returns allotted-resource
+ operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/allotted-resource"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ example: __GLOBAL-CUSTOMER-ID__
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
+ type: string
+ example: __SERVICE-TYPE__
+ - name: service-instance-id
+ in: path
+ description: Uniquely identifies this instance of a service
+ required: true
+ type: string
+ example: __SERVICE-INSTANCE-ID__
+ - name: id
+ in: path
+ description: Allotted Resource id UUID assigned to this instance.
+ required: true
+ type: string
+ example: __ID__
+ - name: subscriber-name
+ in: query
+ description: Subscriber name, an alternate way to retrieve a customer.
+ required: false
+ type: string
+ - name: subscriber-type
+ in: query
+ description: Subscriber type, a way to provide VID with only the INFRA customers.
+ required: false
+ type: string
+ - name: service-instance-name
+ in: query
+ description: This field will store a name assigned to the service-instance.
+ required: false
+ type: string
+ - name: environment-context
+ in: query
+ description: This field will store the environment context assigned to the service-instance.
+ required: false
+ type: string
+ - name: workload-context
+ in: query
+ description: This field will store the workload context assigned to the service-instance.
+ required: false
+ type: string
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ - name: service-instance-location-id
+ in: query
+ description: An identifier that customers assign to the location where this service is being used.
+ required: false
+ type: string
+ - name: orchestration-status
+ in: query
+ description: Orchestration status of this service.
+ required: false
+ type: string
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: type
+ in: query
+ description: Generic description of the type of allotted resource.
+ required: false
+ type: string
+ - name: role
+ in: query
+ description: role in the network that this resource will be providing.
+ required: false
+ type: string
+ put:
+ tags:
+ - Business
+ summary: create or update an existing allotted-resource
+ description: |
+ Create or update an existing allotted-resource.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ example: __GLOBAL-CUSTOMER-ID__
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
+ type: string
+ example: __SERVICE-TYPE__
+ - name: service-instance-id
+ in: path
+ description: Uniquely identifies this instance of a service
+ required: true
+ type: string
+ example: __SERVICE-INSTANCE-ID__
+ - name: id
+ in: path
+ description: Allotted Resource id UUID assigned to this instance.
+ required: true
+ type: string
+ example: __ID__
+ - name: body
+ in: body
+ description: allotted-resource object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)
+ required: true
+ schema:
+ $ref: "#/definitions/allotted-resource"
+ patch:
+ tags:
+ - Business
+ summary: update an existing allotted-resource
+ description: |
+ Update an existing allotted-resource
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ example: __GLOBAL-CUSTOMER-ID__
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
+ type: string
+ example: __SERVICE-TYPE__
+ - name: service-instance-id
+ in: path
+ description: Uniquely identifies this instance of a service
+ required: true
+ type: string
+ example: __SERVICE-INSTANCE-ID__
+ - name: id
+ in: path
+ description: Allotted Resource id UUID assigned to this instance.
+ required: true
+ type: string
+ example: __ID__
+ - name: body
+ in: body
+ description: allotted-resource object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/allotted-resource"
+ delete:
+ tags:
+ - Business
+ summary: delete an existing allotted-resource
+ description: delete an existing allotted-resource
+ operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ example: __GLOBAL-CUSTOMER-ID__
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
+ type: string
+ example: __SERVICE-TYPE__
+ - name: service-instance-id
+ in: path
+ description: Uniquely identifies this instance of a service
+ required: true
+ type: string
+ example: __SERVICE-INSTANCE-ID__
+ - name: id
+ in: path
+ description: Allotted Resource id UUID assigned to this instance.
+ required: true
+ type: string
+ example: __ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources:
+ get:
+ tags:
+ - Business
+ summary: returns allotted-resources
+ description: returns allotted-resources
+ operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResources
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/allotted-resources"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ example: __GLOBAL-CUSTOMER-ID__
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
+ type: string
+ example: __SERVICE-TYPE__
+ - name: service-instance-id
+ in: path
+ description: Uniquely identifies this instance of a service
+ required: true
+ type: string
+ example: __SERVICE-INSTANCE-ID__
+ - name: subscriber-name
+ in: query
+ description: Subscriber name, an alternate way to retrieve a customer.
+ required: false
+ type: string
+ - name: subscriber-type
+ in: query
+ description: Subscriber type, a way to provide VID with only the INFRA customers.
+ required: false
+ type: string
+ - name: service-instance-name
+ in: query
+ description: This field will store a name assigned to the service-instance.
+ required: false
+ type: string
+ - name: environment-context
+ in: query
+ description: This field will store the environment context assigned to the service-instance.
+ required: false
+ type: string
+ - name: workload-context
+ in: query
+ description: This field will store the workload context assigned to the service-instance.
+ required: false
+ type: string
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ - name: service-instance-location-id
+ in: query
+ description: An identifier that customers assign to the location where this service is being used.
+ required: false
+ type: string
+ - name: orchestration-status
+ in: query
+ description: Orchestration status of this service.
+ required: false
+ type: string
+ /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}:
+ get:
+ tags:
+ - Business
+ summary: returns service-instance
+ description: returns service-instance
+ operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/service-instance"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ example: __GLOBAL-CUSTOMER-ID__
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
+ type: string
+ example: __SERVICE-TYPE__
+ - name: service-instance-id
+ in: path
+ description: Uniquely identifies this instance of a service
+ required: true
+ type: string
+ example: __SERVICE-INSTANCE-ID__
+ - name: subscriber-name
+ in: query
+ description: Subscriber name, an alternate way to retrieve a customer.
+ required: false
+ type: string
+ - name: subscriber-type
+ in: query
+ description: Subscriber type, a way to provide VID with only the INFRA customers.
+ required: false
+ type: string
+ - name: service-instance-name
+ in: query
+ description: This field will store a name assigned to the service-instance.
+ required: false
+ type: string
+ - name: environment-context
+ in: query
+ description: This field will store the environment context assigned to the service-instance.
+ required: false
+ type: string
+ - name: workload-context
+ in: query
+ description: This field will store the workload context assigned to the service-instance.
+ required: false
+ type: string
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ - name: service-instance-location-id
+ in: query
+ description: An identifier that customers assign to the location where this service is being used.
+ required: false
+ type: string
+ - name: orchestration-status
+ in: query
+ description: Orchestration status of this service.
+ required: false
+ type: string
+ put:
+ tags:
+ - Business
+ summary: create or update an existing service-instance
+ description: |
+ Create or update an existing service-instance.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ example: __GLOBAL-CUSTOMER-ID__
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
+ type: string
+ example: __SERVICE-TYPE__
+ - name: service-instance-id
+ in: path
+ description: Uniquely identifies this instance of a service
+ required: true
+ type: string
+ example: __SERVICE-INSTANCE-ID__
+ - name: body
+ in: body
+ description: service-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)
+ required: true
+ schema:
+ $ref: "#/definitions/service-instance"
+ patch:
+ tags:
+ - Business
+ summary: update an existing service-instance
+ description: |
+ Update an existing service-instance
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ example: __GLOBAL-CUSTOMER-ID__
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
+ type: string
+ example: __SERVICE-TYPE__
+ - name: service-instance-id
+ in: path
+ description: Uniquely identifies this instance of a service
+ required: true
+ type: string
+ example: __SERVICE-INSTANCE-ID__
+ - name: body
+ in: body
+ description: service-instance object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/service-instance"
+ delete:
+ tags:
+ - Business
+ summary: delete an existing service-instance
+ description: delete an existing service-instance
+ operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ example: __GLOBAL-CUSTOMER-ID__
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
+ type: string
+ example: __SERVICE-TYPE__
+ - name: service-instance-id
+ in: path
+ description: Uniquely identifies this instance of a service
+ required: true
+ type: string
+ example: __SERVICE-INSTANCE-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances:
+ get:
+ tags:
+ - Business
+ summary: returns service-instances
+ description: returns service-instances
+ operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstances
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/service-instances"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ example: __GLOBAL-CUSTOMER-ID__
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
+ type: string
+ example: __SERVICE-TYPE__
+ - name: subscriber-name
+ in: query
+ description: Subscriber name, an alternate way to retrieve a customer.
+ required: false
+ type: string
+ - name: subscriber-type
+ in: query
+ description: Subscriber type, a way to provide VID with only the INFRA customers.
+ required: false
+ type: string
+ /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship:
+ put:
+ tags:
+ - Business
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ example: __GLOBAL-CUSTOMER-ID__
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
+ type: string
+ example: __SERVICE-TYPE__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Business
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ example: __GLOBAL-CUSTOMER-ID__
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
+ type: string
+ example: __SERVICE-TYPE__
+ /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}:
+ get:
+ tags:
+ - Business
+ summary: returns service-subscription
+ description: returns service-subscription
+ operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/service-subscription"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ example: __GLOBAL-CUSTOMER-ID__
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
+ type: string
+ example: __SERVICE-TYPE__
+ - name: subscriber-name
+ in: query
+ description: Subscriber name, an alternate way to retrieve a customer.
+ required: false
+ type: string
+ - name: subscriber-type
+ in: query
+ description: Subscriber type, a way to provide VID with only the INFRA customers.
+ required: false
+ type: string
+ put:
+ tags:
+ - Business
+ summary: create or update an existing service-subscription
+ description: |
+ Create or update an existing service-subscription.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ example: __GLOBAL-CUSTOMER-ID__
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
+ type: string
+ example: __SERVICE-TYPE__
+ - name: body
+ in: body
+ description: service-subscription object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)
+ required: true
+ schema:
+ $ref: "#/definitions/service-subscription"
+ patch:
+ tags:
+ - Business
+ summary: update an existing service-subscription
+ description: |
+ Update an existing service-subscription
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ example: __GLOBAL-CUSTOMER-ID__
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
+ type: string
+ example: __SERVICE-TYPE__
+ - name: body
+ in: body
+ description: service-subscription object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/service-subscription"
+ delete:
+ tags:
+ - Business
+ summary: delete an existing service-subscription
+ description: delete an existing service-subscription
+ operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ example: __GLOBAL-CUSTOMER-ID__
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
+ type: string
+ example: __SERVICE-TYPE__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /business/customers/customer/{global-customer-id}/service-subscriptions:
+ get:
+ tags:
+ - Business
+ summary: returns service-subscriptions
+ description: returns service-subscriptions
+ operationId: getBusinessCustomersCustomerServiceSubscriptions
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/service-subscriptions"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ example: __GLOBAL-CUSTOMER-ID__
+ - name: subscriber-name
+ in: query
+ description: Subscriber name, an alternate way to retrieve a customer.
+ required: false
+ type: string
+ - name: subscriber-type
+ in: query
+ description: Subscriber type, a way to provide VID with only the INFRA customers.
+ required: false
+ type: string
+ /business/customers/customer/{global-customer-id}/relationship-list/relationship:
+ put:
+ tags:
+ - Business
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateBusinessCustomersCustomerRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ example: __GLOBAL-CUSTOMER-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomer.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Business
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteBusinessCustomersCustomerRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ example: __GLOBAL-CUSTOMER-ID__
+ /business/customers/customer/{global-customer-id}:
+ get:
+ tags:
+ - Business
+ summary: returns customer
+ description: returns customer
+ operationId: getBusinessCustomersCustomer
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/customer"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ example: __GLOBAL-CUSTOMER-ID__
+ - name: subscriber-name
+ in: query
+ description: Subscriber name, an alternate way to retrieve a customer.
+ required: false
+ type: string
+ - name: subscriber-type
+ in: query
+ description: Subscriber type, a way to provide VID with only the INFRA customers.
+ required: false
+ type: string
+ put:
+ tags:
+ - Business
+ summary: create or update an existing customer
+ description: |
+ Create or update an existing customer.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateBusinessCustomersCustomer
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ example: __GLOBAL-CUSTOMER-ID__
+ - name: body
+ in: body
+ description: customer object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomer.json)
+ required: true
+ schema:
+ $ref: "#/definitions/customer"
+ patch:
+ tags:
+ - Business
+ summary: update an existing customer
+ description: |
+ Update an existing customer
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateBusinessCustomersCustomer
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ example: __GLOBAL-CUSTOMER-ID__
+ - name: body
+ in: body
+ description: customer object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/customer"
+ delete:
+ tags:
+ - Business
+ summary: delete an existing customer
+ description: delete an existing customer
+ operationId: deleteBusinessCustomersCustomer
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ example: __GLOBAL-CUSTOMER-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /business/customers:
+ get:
+ tags:
+ - Business
+ summary: returns customers
+ description: returns customers
+ operationId: getBusinessCustomers
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/customers"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /business/lines-of-business/line-of-business/{line-of-business-name}/relationship-list/relationship:
+ put:
+ tags:
+ - Business
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateBusinessLinesOfBusinessLineOfBusinessRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: line-of-business-name
+ in: path
+ description: Name of the line-of-business (product)
+ required: true
+ type: string
+ example: __LINE-OF-BUSINESS-NAME__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessLinesOfBusinessLineOfBusiness.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Business
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteBusinessLinesOfBusinessLineOfBusinessRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: line-of-business-name
+ in: path
+ description: Name of the line-of-business (product)
+ required: true
+ type: string
+ example: __LINE-OF-BUSINESS-NAME__
+ /business/lines-of-business/line-of-business/{line-of-business-name}:
+ get:
+ tags:
+ - Business
+ summary: returns line-of-business
+ description: returns line-of-business
+ operationId: getBusinessLinesOfBusinessLineOfBusiness
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/line-of-business"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: line-of-business-name
+ in: path
+ description: Name of the line-of-business (product)
+ required: true
+ type: string
+ example: __LINE-OF-BUSINESS-NAME__
+ put:
+ tags:
+ - Business
+ summary: create or update an existing line-of-business
+ description: |
+ Create or update an existing line-of-business.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateBusinessLinesOfBusinessLineOfBusiness
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: line-of-business-name
+ in: path
+ description: Name of the line-of-business (product)
+ required: true
+ type: string
+ example: __LINE-OF-BUSINESS-NAME__
+ - name: body
+ in: body
+ description: line-of-business object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessLinesOfBusinessLineOfBusiness.json)
+ required: true
+ schema:
+ $ref: "#/definitions/line-of-business"
+ patch:
+ tags:
+ - Business
+ summary: update an existing line-of-business
+ description: |
+ Update an existing line-of-business
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateBusinessLinesOfBusinessLineOfBusiness
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: line-of-business-name
+ in: path
+ description: Name of the line-of-business (product)
+ required: true
+ type: string
+ example: __LINE-OF-BUSINESS-NAME__
+ - name: body
+ in: body
+ description: line-of-business object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/line-of-business"
+ delete:
+ tags:
+ - Business
+ summary: delete an existing line-of-business
+ description: delete an existing line-of-business
+ operationId: deleteBusinessLinesOfBusinessLineOfBusiness
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: line-of-business-name
+ in: path
+ description: Name of the line-of-business (product)
+ required: true
+ type: string
+ example: __LINE-OF-BUSINESS-NAME__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /business/lines-of-business:
+ get:
+ tags:
+ - Business
+ summary: returns lines-of-business
+ description: returns lines-of-business
+ operationId: getBusinessLinesOfBusiness
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/lines-of-business"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /business/owning-entities/owning-entity/{owning-entity-id}/relationship-list/relationship:
+ put:
+ tags:
+ - Business
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateBusinessOwningEntitiesOwningEntityRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: owning-entity-id
+ in: path
+ description: UUID of an owning entity
+ required: true
+ type: string
+ example: __OWNING-ENTITY-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessOwningEntitiesOwningEntity.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Business
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteBusinessOwningEntitiesOwningEntityRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: owning-entity-id
+ in: path
+ description: UUID of an owning entity
+ required: true
+ type: string
+ example: __OWNING-ENTITY-ID__
+ /business/owning-entities/owning-entity/{owning-entity-id}:
+ get:
+ tags:
+ - Business
+ summary: returns owning-entity
+ description: returns owning-entity
+ operationId: getBusinessOwningEntitiesOwningEntity
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/owning-entity"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: owning-entity-id
+ in: path
+ description: UUID of an owning entity
+ required: true
+ type: string
+ example: __OWNING-ENTITY-ID__
+ put:
+ tags:
+ - Business
+ summary: create or update an existing owning-entity
+ description: |
+ Create or update an existing owning-entity.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateBusinessOwningEntitiesOwningEntity
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: owning-entity-id
+ in: path
+ description: UUID of an owning entity
+ required: true
+ type: string
+ example: __OWNING-ENTITY-ID__
+ - name: body
+ in: body
+ description: owning-entity object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessOwningEntitiesOwningEntity.json)
+ required: true
+ schema:
+ $ref: "#/definitions/owning-entity"
+ patch:
+ tags:
+ - Business
+ summary: update an existing owning-entity
+ description: |
+ Update an existing owning-entity
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateBusinessOwningEntitiesOwningEntity
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: owning-entity-id
+ in: path
+ description: UUID of an owning entity
+ required: true
+ type: string
+ example: __OWNING-ENTITY-ID__
+ - name: body
+ in: body
+ description: owning-entity object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/owning-entity"
+ delete:
+ tags:
+ - Business
+ summary: delete an existing owning-entity
+ description: delete an existing owning-entity
+ operationId: deleteBusinessOwningEntitiesOwningEntity
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: owning-entity-id
+ in: path
+ description: UUID of an owning entity
+ required: true
+ type: string
+ example: __OWNING-ENTITY-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /business/owning-entities:
+ get:
+ tags:
+ - Business
+ summary: returns owning-entities
+ description: returns owning-entities
+ operationId: getBusinessOwningEntities
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/owning-entities"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /business/platforms/platform/{platform-name}/relationship-list/relationship:
+ put:
+ tags:
+ - Business
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateBusinessPlatformsPlatformRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: platform-name
+ in: path
+ description: Name of the platform
+ required: true
+ type: string
+ example: __PLATFORM-NAME__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessPlatformsPlatform.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Business
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteBusinessPlatformsPlatformRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: platform-name
+ in: path
+ description: Name of the platform
+ required: true
+ type: string
+ example: __PLATFORM-NAME__
+ /business/platforms/platform/{platform-name}:
+ get:
+ tags:
+ - Business
+ summary: returns platform
+ description: returns platform
+ operationId: getBusinessPlatformsPlatform
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/platform"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: platform-name
+ in: path
+ description: Name of the platform
+ required: true
+ type: string
+ example: __PLATFORM-NAME__
+ put:
+ tags:
+ - Business
+ summary: create or update an existing platform
+ description: |
+ Create or update an existing platform.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateBusinessPlatformsPlatform
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: platform-name
+ in: path
+ description: Name of the platform
+ required: true
+ type: string
+ example: __PLATFORM-NAME__
+ - name: body
+ in: body
+ description: platform object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessPlatformsPlatform.json)
+ required: true
+ schema:
+ $ref: "#/definitions/platform"
+ patch:
+ tags:
+ - Business
+ summary: update an existing platform
+ description: |
+ Update an existing platform
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateBusinessPlatformsPlatform
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: platform-name
+ in: path
+ description: Name of the platform
+ required: true
+ type: string
+ example: __PLATFORM-NAME__
+ - name: body
+ in: body
+ description: platform object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/platform"
+ delete:
+ tags:
+ - Business
+ summary: delete an existing platform
+ description: delete an existing platform
+ operationId: deleteBusinessPlatformsPlatform
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: platform-name
+ in: path
+ description: Name of the platform
+ required: true
+ type: string
+ example: __PLATFORM-NAME__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /business/platforms:
+ get:
+ tags:
+ - Business
+ summary: returns platforms
+ description: returns platforms
+ operationId: getBusinessPlatforms
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/platforms"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /business/projects/project/{project-name}/relationship-list/relationship:
+ put:
+ tags:
+ - Business
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateBusinessProjectsProjectRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: project-name
+ in: path
+ description: Name of the project deploying a service
+ required: true
+ type: string
+ example: __PROJECT-NAME__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessProjectsProject.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Business
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteBusinessProjectsProjectRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: project-name
+ in: path
+ description: Name of the project deploying a service
+ required: true
+ type: string
+ example: __PROJECT-NAME__
+ /business/projects/project/{project-name}:
+ get:
+ tags:
+ - Business
+ summary: returns project
+ description: returns project
+ operationId: getBusinessProjectsProject
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/project"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: project-name
+ in: path
+ description: Name of the project deploying a service
+ required: true
+ type: string
+ example: __PROJECT-NAME__
+ put:
+ tags:
+ - Business
+ summary: create or update an existing project
+ description: |
+ Create or update an existing project.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateBusinessProjectsProject
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: project-name
+ in: path
+ description: Name of the project deploying a service
+ required: true
+ type: string
+ example: __PROJECT-NAME__
+ - name: body
+ in: body
+ description: project object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessProjectsProject.json)
+ required: true
+ schema:
+ $ref: "#/definitions/project"
+ patch:
+ tags:
+ - Business
+ summary: update an existing project
+ description: |
+ Update an existing project
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateBusinessProjectsProject
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: project-name
+ in: path
+ description: Name of the project deploying a service
+ required: true
+ type: string
+ example: __PROJECT-NAME__
+ - name: body
+ in: body
+ description: project object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/project"
+ delete:
+ tags:
+ - Business
+ summary: delete an existing project
+ description: delete an existing project
+ operationId: deleteBusinessProjectsProject
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: project-name
+ in: path
+ description: Name of the project deploying a service
+ required: true
+ type: string
+ example: __PROJECT-NAME__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /business/projects:
+ get:
+ tags:
+ - Business
+ summary: returns projects
+ description: returns projects
+ operationId: getBusinessProjects
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/projects"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship:
+ put:
+ tags:
+ - ServiceDesignAndCreation
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-image-uuid
+ in: path
+ description: Unique ID of this asset
+ required: true
+ type: string
+ example: __VNF-IMAGE-UUID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationVnfImagesVnfImage.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - ServiceDesignAndCreation
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-image-uuid
+ in: path
+ description: Unique ID of this asset
+ required: true
+ type: string
+ example: __VNF-IMAGE-UUID__
+ /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}:
+ get:
+ tags:
+ - ServiceDesignAndCreation
+ summary: returns vnf-image
+ description: returns vnf-image
+ operationId: getServiceDesignAndCreationVnfImagesVnfImage
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/vnf-image"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-image-uuid
+ in: path
+ description: Unique ID of this asset
+ required: true
+ type: string
+ example: __VNF-IMAGE-UUID__
+ - name: application
+ in: query
+ description: The application that the image instantiates.
+ required: false
+ type: string
+ - name: application-vendor
+ in: query
+ description: The vendor of the application.
+ required: false
+ type: string
+ - name: application-version
+ in: query
+ description: The version of the application.
+ required: false
+ type: string
+ put:
+ tags:
+ - ServiceDesignAndCreation
+ summary: create or update an existing vnf-image
+ description: |
+ Create or update an existing vnf-image.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImage
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-image-uuid
+ in: path
+ description: Unique ID of this asset
+ required: true
+ type: string
+ example: __VNF-IMAGE-UUID__
+ - name: body
+ in: body
+ description: vnf-image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationVnfImagesVnfImage.json)
+ required: true
+ schema:
+ $ref: "#/definitions/vnf-image"
+ patch:
+ tags:
+ - ServiceDesignAndCreation
+ summary: update an existing vnf-image
+ description: |
+ Update an existing vnf-image
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateServiceDesignAndCreationVnfImagesVnfImage
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-image-uuid
+ in: path
+ description: Unique ID of this asset
+ required: true
+ type: string
+ example: __VNF-IMAGE-UUID__
+ - name: body
+ in: body
+ description: vnf-image object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/vnf-image"
+ delete:
+ tags:
+ - ServiceDesignAndCreation
+ summary: delete an existing vnf-image
+ description: delete an existing vnf-image
+ operationId: deleteServiceDesignAndCreationVnfImagesVnfImage
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-image-uuid
+ in: path
+ description: Unique ID of this asset
+ required: true
+ type: string
+ example: __VNF-IMAGE-UUID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /service-design-and-creation/vnf-images:
+ get:
+ tags:
+ - ServiceDesignAndCreation
+ summary: returns vnf-images
+ description: returns vnf-images
+ operationId: getServiceDesignAndCreationVnfImages
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/vnf-images"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /service-design-and-creation/services/service/{service-id}/relationship-list/relationship:
+ put:
+ tags:
+ - ServiceDesignAndCreation
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateServiceDesignAndCreationServicesServiceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: service-id
+ in: path
+ description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
+ required: true
+ type: string
+ example: __SERVICE-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationServicesService.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - ServiceDesignAndCreation
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteServiceDesignAndCreationServicesServiceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: service-id
+ in: path
+ description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
+ required: true
+ type: string
+ example: __SERVICE-ID__
+ /service-design-and-creation/services/service/{service-id}:
+ get:
+ tags:
+ - ServiceDesignAndCreation
+ summary: returns service
+ description: returns service
+ operationId: getServiceDesignAndCreationServicesService
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/service"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: service-id
+ in: path
+ description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
+ required: true
+ type: string
+ example: __SERVICE-ID__
+ - name: service-description
+ in: query
+ description: Description of the service
+ required: false
+ type: string
+ put:
+ tags:
+ - ServiceDesignAndCreation
+ summary: create or update an existing service
+ description: |
+ Create or update an existing service.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateServiceDesignAndCreationServicesService
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: service-id
+ in: path
+ description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
+ required: true
+ type: string
+ example: __SERVICE-ID__
+ - name: body
+ in: body
+ description: service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationServicesService.json)
+ required: true
+ schema:
+ $ref: "#/definitions/service"
+ patch:
+ tags:
+ - ServiceDesignAndCreation
+ summary: update an existing service
+ description: |
+ Update an existing service
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateServiceDesignAndCreationServicesService
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: service-id
+ in: path
+ description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
+ required: true
+ type: string
+ example: __SERVICE-ID__
+ - name: body
+ in: body
+ description: service object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/service"
+ delete:
+ tags:
+ - ServiceDesignAndCreation
+ summary: delete an existing service
+ description: delete an existing service
+ operationId: deleteServiceDesignAndCreationServicesService
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: service-id
+ in: path
+ description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
+ required: true
+ type: string
+ example: __SERVICE-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /service-design-and-creation/services:
+ get:
+ tags:
+ - ServiceDesignAndCreation
+ summary: returns services
+ description: returns services
+ operationId: getServiceDesignAndCreationServices
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/services"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship:
+ put:
+ tags:
+ - ServiceDesignAndCreation
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: service-type
+ in: path
+ description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
+ required: true
+ type: string
+ example: __SERVICE-TYPE__
+ - name: vnf-type
+ in: path
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: true
+ type: string
+ example: __VNF-TYPE__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - ServiceDesignAndCreation
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: service-type
+ in: path
+ description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
+ required: true
+ type: string
+ example: __SERVICE-TYPE__
+ - name: vnf-type
+ in: path
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: true
+ type: string
+ example: __VNF-TYPE__
+ /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}:
+ get:
+ tags:
+ - ServiceDesignAndCreation
+ summary: returns service-capability
+ description: returns service-capability
+ operationId: getServiceDesignAndCreationServiceCapabilitiesServiceCapability
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/service-capability"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: service-type
+ in: path
+ description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
+ required: true
+ type: string
+ example: __SERVICE-TYPE__
+ - name: vnf-type
+ in: path
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: true
+ type: string
+ example: __VNF-TYPE__
+ put:
+ tags:
+ - ServiceDesignAndCreation
+ summary: create or update an existing service-capability
+ description: |
+ Create or update an existing service-capability.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: service-type
+ in: path
+ description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
+ required: true
+ type: string
+ example: __SERVICE-TYPE__
+ - name: vnf-type
+ in: path
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: true
+ type: string
+ example: __VNF-TYPE__
+ - name: body
+ in: body
+ description: service-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)
+ required: true
+ schema:
+ $ref: "#/definitions/service-capability"
+ patch:
+ tags:
+ - ServiceDesignAndCreation
+ summary: update an existing service-capability
+ description: |
+ Update an existing service-capability
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: service-type
+ in: path
+ description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
+ required: true
+ type: string
+ example: __SERVICE-TYPE__
+ - name: vnf-type
+ in: path
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: true
+ type: string
+ example: __VNF-TYPE__
+ - name: body
+ in: body
+ description: service-capability object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/service-capability"
+ delete:
+ tags:
+ - ServiceDesignAndCreation
+ summary: delete an existing service-capability
+ description: delete an existing service-capability
+ operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapability
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: service-type
+ in: path
+ description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
+ required: true
+ type: string
+ example: __SERVICE-TYPE__
+ - name: vnf-type
+ in: path
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: true
+ type: string
+ example: __VNF-TYPE__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /service-design-and-creation/service-capabilities:
+ get:
+ tags:
+ - ServiceDesignAndCreation
+ summary: returns service-capabilities
+ description: returns service-capabilities
+ operationId: getServiceDesignAndCreationServiceCapabilities
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/service-capabilities"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /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:
+ tags:
+ - ServiceDesignAndCreation
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-INVARIANT-ID__
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-VERSION-ID__
+ - name: model-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-ELEMENT-UUID__
+ - name: model-constraint-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-CONSTRAINT-UUID__
+ - name: constrained-element-set-uuid
+ in: path
+ required: true
+ type: string
+ example: __CONSTRAINED-ELEMENT-SET-UUID__
+ - name: element-choice-set-uuid
+ in: path
+ required: true
+ type: string
+ example: __ELEMENT-CHOICE-SET-UUID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - ServiceDesignAndCreation
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-INVARIANT-ID__
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-VERSION-ID__
+ - name: model-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-ELEMENT-UUID__
+ - name: model-constraint-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-CONSTRAINT-UUID__
+ - name: constrained-element-set-uuid
+ in: path
+ required: true
+ type: string
+ example: __CONSTRAINED-ELEMENT-SET-UUID__
+ - name: element-choice-set-uuid
+ in: path
+ required: true
+ type: string
+ example: __ELEMENT-CHOICE-SET-UUID__
+ /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:
+ tags:
+ - ServiceDesignAndCreation
+ summary: returns element-choice-set
+ description: returns element-choice-set
+ operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/element-choice-set"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-INVARIANT-ID__
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-VERSION-ID__
+ - name: model-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-ELEMENT-UUID__
+ - name: model-constraint-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-CONSTRAINT-UUID__
+ - name: constrained-element-set-uuid
+ in: path
+ required: true
+ type: string
+ example: __CONSTRAINED-ELEMENT-SET-UUID__
+ - name: element-choice-set-uuid
+ in: path
+ required: true
+ type: string
+ example: __ELEMENT-CHOICE-SET-UUID__
+ - name: model-type
+ in: query
+ description: Type of the model, e.g., service, resource, widget, etc.
+ required: false
+ type: string
+ - name: model-name
+ in: query
+ description: Name of the model, which can change from version to version.
+ required: false
+ type: string
+ - name: model-version
+ in: query
+ description: Version
+ required: false
+ type: string
+ - name: distribution-status
+ in: query
+ description: Distribution Status
+ required: false
+ type: string
+ put:
+ tags:
+ - ServiceDesignAndCreation
+ summary: create or update an existing element-choice-set
+ description: |
+ Create or update an existing element-choice-set.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-INVARIANT-ID__
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-VERSION-ID__
+ - name: model-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-ELEMENT-UUID__
+ - name: model-constraint-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-CONSTRAINT-UUID__
+ - name: constrained-element-set-uuid
+ in: path
+ required: true
+ type: string
+ example: __CONSTRAINED-ELEMENT-SET-UUID__
+ - name: element-choice-set-uuid
+ in: path
+ required: true
+ type: string
+ example: __ELEMENT-CHOICE-SET-UUID__
+ - name: body
+ in: body
+ description: element-choice-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)
+ required: true
+ schema:
+ $ref: "#/definitions/element-choice-set"
+ patch:
+ tags:
+ - ServiceDesignAndCreation
+ summary: update an existing element-choice-set
+ description: |
+ Update an existing element-choice-set
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-INVARIANT-ID__
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-VERSION-ID__
+ - name: model-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-ELEMENT-UUID__
+ - name: model-constraint-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-CONSTRAINT-UUID__
+ - name: constrained-element-set-uuid
+ in: path
+ required: true
+ type: string
+ example: __CONSTRAINED-ELEMENT-SET-UUID__
+ - name: element-choice-set-uuid
+ in: path
+ required: true
+ type: string
+ example: __ELEMENT-CHOICE-SET-UUID__
+ - name: body
+ in: body
+ description: element-choice-set object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/element-choice-set"
+ delete:
+ tags:
+ - ServiceDesignAndCreation
+ summary: delete an existing element-choice-set
+ description: delete an existing element-choice-set
+ operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-INVARIANT-ID__
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-VERSION-ID__
+ - name: model-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-ELEMENT-UUID__
+ - name: model-constraint-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-CONSTRAINT-UUID__
+ - name: constrained-element-set-uuid
+ in: path
+ required: true
+ type: string
+ example: __CONSTRAINED-ELEMENT-SET-UUID__
+ - name: element-choice-set-uuid
+ in: path
+ required: true
+ type: string
+ example: __ELEMENT-CHOICE-SET-UUID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /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:
+ tags:
+ - ServiceDesignAndCreation
+ summary: returns element-choice-sets
+ description: returns element-choice-sets
+ operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSets
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/element-choice-sets"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-INVARIANT-ID__
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-VERSION-ID__
+ - name: model-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-ELEMENT-UUID__
+ - name: model-constraint-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-CONSTRAINT-UUID__
+ - name: constrained-element-set-uuid
+ in: path
+ required: true
+ type: string
+ example: __CONSTRAINED-ELEMENT-SET-UUID__
+ - name: model-type
+ in: query
+ description: Type of the model, e.g., service, resource, widget, etc.
+ required: false
+ type: string
+ - name: model-name
+ in: query
+ description: Name of the model, which can change from version to version.
+ required: false
+ type: string
+ - name: model-version
+ in: query
+ description: Version
+ required: false
+ type: string
+ - name: distribution-status
+ in: query
+ description: Distribution Status
+ required: false
+ type: string
+ /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:
+ tags:
+ - ServiceDesignAndCreation
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-INVARIANT-ID__
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-VERSION-ID__
+ - name: model-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-ELEMENT-UUID__
+ - name: model-constraint-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-CONSTRAINT-UUID__
+ - name: constrained-element-set-uuid
+ in: path
+ required: true
+ type: string
+ example: __CONSTRAINED-ELEMENT-SET-UUID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - ServiceDesignAndCreation
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-INVARIANT-ID__
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-VERSION-ID__
+ - name: model-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-ELEMENT-UUID__
+ - name: model-constraint-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-CONSTRAINT-UUID__
+ - name: constrained-element-set-uuid
+ in: path
+ required: true
+ type: string
+ example: __CONSTRAINED-ELEMENT-SET-UUID__
+ /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:
+ tags:
+ - ServiceDesignAndCreation
+ summary: returns constrained-element-set
+ description: returns constrained-element-set
+ operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/constrained-element-set"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-INVARIANT-ID__
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-VERSION-ID__
+ - name: model-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-ELEMENT-UUID__
+ - name: model-constraint-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-CONSTRAINT-UUID__
+ - name: constrained-element-set-uuid
+ in: path
+ required: true
+ type: string
+ example: __CONSTRAINED-ELEMENT-SET-UUID__
+ - name: model-type
+ in: query
+ description: Type of the model, e.g., service, resource, widget, etc.
+ required: false
+ type: string
+ - name: model-name
+ in: query
+ description: Name of the model, which can change from version to version.
+ required: false
+ type: string
+ - name: model-version
+ in: query
+ description: Version
+ required: false
+ type: string
+ - name: distribution-status
+ in: query
+ description: Distribution Status
+ required: false
+ type: string
+ put:
+ tags:
+ - ServiceDesignAndCreation
+ summary: create or update an existing constrained-element-set
+ description: |
+ Create or update an existing constrained-element-set.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-INVARIANT-ID__
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-VERSION-ID__
+ - name: model-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-ELEMENT-UUID__
+ - name: model-constraint-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-CONSTRAINT-UUID__
+ - name: constrained-element-set-uuid
+ in: path
+ required: true
+ type: string
+ example: __CONSTRAINED-ELEMENT-SET-UUID__
+ - name: body
+ in: body
+ description: constrained-element-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
+ required: true
+ schema:
+ $ref: "#/definitions/constrained-element-set"
+ patch:
+ tags:
+ - ServiceDesignAndCreation
+ summary: update an existing constrained-element-set
+ description: |
+ Update an existing constrained-element-set
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-INVARIANT-ID__
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-VERSION-ID__
+ - name: model-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-ELEMENT-UUID__
+ - name: model-constraint-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-CONSTRAINT-UUID__
+ - name: constrained-element-set-uuid
+ in: path
+ required: true
+ type: string
+ example: __CONSTRAINED-ELEMENT-SET-UUID__
+ - name: body
+ in: body
+ description: constrained-element-set object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/constrained-element-set"
+ delete:
+ tags:
+ - ServiceDesignAndCreation
+ summary: delete an existing constrained-element-set
+ description: delete an existing constrained-element-set
+ operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-INVARIANT-ID__
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-VERSION-ID__
+ - name: model-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-ELEMENT-UUID__
+ - name: model-constraint-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-CONSTRAINT-UUID__
+ - name: constrained-element-set-uuid
+ in: path
+ required: true
+ type: string
+ example: __CONSTRAINED-ELEMENT-SET-UUID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /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:
+ tags:
+ - ServiceDesignAndCreation
+ summary: returns constrained-element-sets
+ description: returns constrained-element-sets
+ operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSets
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/constrained-element-sets"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-INVARIANT-ID__
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-VERSION-ID__
+ - name: model-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-ELEMENT-UUID__
+ - name: model-constraint-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-CONSTRAINT-UUID__
+ - name: model-type
+ in: query
+ description: Type of the model, e.g., service, resource, widget, etc.
+ required: false
+ type: string
+ - name: model-name
+ in: query
+ description: Name of the model, which can change from version to version.
+ required: false
+ type: string
+ - name: model-version
+ in: query
+ description: Version
+ required: false
+ type: string
+ - name: distribution-status
+ in: query
+ description: Distribution Status
+ required: false
+ type: string
+ /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:
+ tags:
+ - ServiceDesignAndCreation
+ summary: returns model-constraint
+ description: returns model-constraint
+ operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/model-constraint"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-INVARIANT-ID__
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-VERSION-ID__
+ - name: model-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-ELEMENT-UUID__
+ - name: model-constraint-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-CONSTRAINT-UUID__
+ - name: model-type
+ in: query
+ description: Type of the model, e.g., service, resource, widget, etc.
+ required: false
+ type: string
+ - name: model-name
+ in: query
+ description: Name of the model, which can change from version to version.
+ required: false
+ type: string
+ - name: model-version
+ in: query
+ description: Version
+ required: false
+ type: string
+ - name: distribution-status
+ in: query
+ description: Distribution Status
+ required: false
+ type: string
+ put:
+ tags:
+ - ServiceDesignAndCreation
+ summary: create or update an existing model-constraint
+ description: |
+ Create or update an existing model-constraint.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-INVARIANT-ID__
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-VERSION-ID__
+ - name: model-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-ELEMENT-UUID__
+ - name: model-constraint-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-CONSTRAINT-UUID__
+ - name: body
+ in: body
+ description: model-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint.json)
+ required: true
+ schema:
+ $ref: "#/definitions/model-constraint"
+ patch:
+ tags:
+ - ServiceDesignAndCreation
+ summary: update an existing model-constraint
+ description: |
+ Update an existing model-constraint
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-INVARIANT-ID__
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-VERSION-ID__
+ - name: model-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-ELEMENT-UUID__
+ - name: model-constraint-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-CONSTRAINT-UUID__
+ - name: body
+ in: body
+ description: model-constraint object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/model-constraint"
+ delete:
+ tags:
+ - ServiceDesignAndCreation
+ summary: delete an existing model-constraint
+ description: delete an existing model-constraint
+ operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-INVARIANT-ID__
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-VERSION-ID__
+ - name: model-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-ELEMENT-UUID__
+ - name: model-constraint-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-CONSTRAINT-UUID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /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:
+ tags:
+ - ServiceDesignAndCreation
+ summary: returns model-constraints
+ description: returns model-constraints
+ operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraints
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/model-constraints"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-INVARIANT-ID__
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-VERSION-ID__
+ - name: model-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-ELEMENT-UUID__
+ - name: model-type
+ in: query
+ description: Type of the model, e.g., service, resource, widget, etc.
+ required: false
+ type: string
+ - name: model-name
+ in: query
+ description: Name of the model, which can change from version to version.
+ required: false
+ type: string
+ - name: model-version
+ in: query
+ description: Version
+ required: false
+ type: string
+ - name: distribution-status
+ in: query
+ description: Distribution Status
+ required: false
+ type: string
+ /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:
+ tags:
+ - ServiceDesignAndCreation
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-INVARIANT-ID__
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-VERSION-ID__
+ - name: model-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-ELEMENT-UUID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - ServiceDesignAndCreation
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-INVARIANT-ID__
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-VERSION-ID__
+ - name: model-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-ELEMENT-UUID__
+ /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}:
+ get:
+ tags:
+ - ServiceDesignAndCreation
+ summary: returns model-element
+ description: returns model-element
+ operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/model-element"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-INVARIANT-ID__
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-VERSION-ID__
+ - name: model-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-ELEMENT-UUID__
+ - name: model-type
+ in: query
+ description: Type of the model, e.g., service, resource, widget, etc.
+ required: false
+ type: string
+ - name: model-name
+ in: query
+ description: Name of the model, which can change from version to version.
+ required: false
+ type: string
+ - name: model-version
+ in: query
+ description: Version
+ required: false
+ type: string
+ - name: distribution-status
+ in: query
+ description: Distribution Status
+ required: false
+ type: string
+ put:
+ tags:
+ - ServiceDesignAndCreation
+ summary: create or update an existing model-element
+ description: |
+ Create or update an existing model-element.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-INVARIANT-ID__
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-VERSION-ID__
+ - name: model-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-ELEMENT-UUID__
+ - name: body
+ in: body
+ description: model-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)
+ required: true
+ schema:
+ $ref: "#/definitions/model-element"
+ patch:
+ tags:
+ - ServiceDesignAndCreation
+ summary: update an existing model-element
+ description: |
+ Update an existing model-element
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-INVARIANT-ID__
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-VERSION-ID__
+ - name: model-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-ELEMENT-UUID__
+ - name: body
+ in: body
+ description: model-element object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/model-element"
+ delete:
+ tags:
+ - ServiceDesignAndCreation
+ summary: delete an existing model-element
+ description: delete an existing model-element
+ operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-INVARIANT-ID__
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-VERSION-ID__
+ - name: model-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __MODEL-ELEMENT-UUID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements:
+ get:
+ tags:
+ - ServiceDesignAndCreation
+ summary: returns model-elements
+ description: returns model-elements
+ operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElements
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/model-elements"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-INVARIANT-ID__
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-VERSION-ID__
+ - name: model-type
+ in: query
+ description: Type of the model, e.g., service, resource, widget, etc.
+ required: false
+ type: string
+ - name: model-name
+ in: query
+ description: Name of the model, which can change from version to version.
+ required: false
+ type: string
+ - name: model-version
+ in: query
+ description: Version
+ required: false
+ type: string
+ - name: distribution-status
+ in: query
+ description: Distribution Status
+ required: false
+ type: string
+ /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}:
+ get:
+ tags:
+ - ServiceDesignAndCreation
+ summary: returns metadatum
+ description: returns metadatum
+ operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/metadatum"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-INVARIANT-ID__
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-VERSION-ID__
+ - name: metaname
+ in: path
+ required: true
+ type: string
+ example: __METANAME__
+ - name: model-type
+ in: query
+ description: Type of the model, e.g., service, resource, widget, etc.
+ required: false
+ type: string
+ - name: model-name
+ in: query
+ description: Name of the model, which can change from version to version.
+ required: false
+ type: string
+ - name: model-version
+ in: query
+ description: Version
+ required: false
+ type: string
+ - name: distribution-status
+ in: query
+ description: Distribution Status
+ required: false
+ type: string
+ put:
+ tags:
+ - ServiceDesignAndCreation
+ summary: create or update an existing metadatum
+ description: |
+ Create or update an existing metadatum.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-INVARIANT-ID__
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-VERSION-ID__
+ - name: metaname
+ in: path
+ required: true
+ type: string
+ example: __METANAME__
+ - name: body
+ in: body
+ description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum.json)
+ required: true
+ schema:
+ $ref: "#/definitions/metadatum"
+ patch:
+ tags:
+ - ServiceDesignAndCreation
+ summary: update an existing metadatum
+ description: |
+ Update an existing metadatum
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-INVARIANT-ID__
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-VERSION-ID__
+ - name: metaname
+ in: path
+ required: true
+ type: string
+ example: __METANAME__
+ - name: body
+ in: body
+ description: metadatum object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/metadatum"
+ delete:
+ tags:
+ - ServiceDesignAndCreation
+ summary: delete an existing metadatum
+ description: delete an existing metadatum
+ operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-INVARIANT-ID__
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-VERSION-ID__
+ - name: metaname
+ in: path
+ required: true
+ type: string
+ example: __METANAME__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata:
+ get:
+ tags:
+ - ServiceDesignAndCreation
+ summary: returns metadata
+ description: returns metadata
+ operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadata
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/metadata"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-INVARIANT-ID__
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-VERSION-ID__
+ - name: model-type
+ in: query
+ description: Type of the model, e.g., service, resource, widget, etc.
+ required: false
+ type: string
+ - name: model-name
+ in: query
+ description: Name of the model, which can change from version to version.
+ required: false
+ type: string
+ - name: model-version
+ in: query
+ description: Version
+ required: false
+ type: string
+ - name: distribution-status
+ in: query
+ description: Distribution Status
+ required: false
+ type: string
+ /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship:
+ put:
+ tags:
+ - ServiceDesignAndCreation
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-INVARIANT-ID__
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-VERSION-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVer.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - ServiceDesignAndCreation
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-INVARIANT-ID__
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-VERSION-ID__
+ /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}:
+ get:
+ tags:
+ - ServiceDesignAndCreation
+ summary: returns model-ver
+ description: returns model-ver
+ operationId: getServiceDesignAndCreationModelsModelModelVersModelVer
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/model-ver"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-INVARIANT-ID__
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-VERSION-ID__
+ - name: model-type
+ in: query
+ description: Type of the model, e.g., service, resource, widget, etc.
+ required: false
+ type: string
+ - name: model-name
+ in: query
+ description: Name of the model, which can change from version to version.
+ required: false
+ type: string
+ - name: model-version
+ in: query
+ description: Version
+ required: false
+ type: string
+ - name: distribution-status
+ in: query
+ description: Distribution Status
+ required: false
+ type: string
+ put:
+ tags:
+ - ServiceDesignAndCreation
+ summary: create or update an existing model-ver
+ description: |
+ Create or update an existing model-ver.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVer
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-INVARIANT-ID__
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-VERSION-ID__
+ - name: body
+ in: body
+ description: model-ver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVer.json)
+ required: true
+ schema:
+ $ref: "#/definitions/model-ver"
+ patch:
+ tags:
+ - ServiceDesignAndCreation
+ summary: update an existing model-ver
+ description: |
+ Update an existing model-ver
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVer
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-INVARIANT-ID__
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-VERSION-ID__
+ - name: body
+ in: body
+ description: model-ver object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/model-ver"
+ delete:
+ tags:
+ - ServiceDesignAndCreation
+ summary: delete an existing model-ver
+ description: delete an existing model-ver
+ operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVer
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-INVARIANT-ID__
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-VERSION-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /service-design-and-creation/models/model/{model-invariant-id}/model-vers:
+ get:
+ tags:
+ - ServiceDesignAndCreation
+ summary: returns model-vers
+ description: returns model-vers
+ operationId: getServiceDesignAndCreationModelsModelModelVers
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/model-vers"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-INVARIANT-ID__
+ - name: model-type
+ in: query
+ description: Type of the model, e.g., service, resource, widget, etc.
+ required: false
+ type: string
+ /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship:
+ put:
+ tags:
+ - ServiceDesignAndCreation
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateServiceDesignAndCreationModelsModelRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-INVARIANT-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModel.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - ServiceDesignAndCreation
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteServiceDesignAndCreationModelsModelRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-INVARIANT-ID__
+ /service-design-and-creation/models/model/{model-invariant-id}:
+ get:
+ tags:
+ - ServiceDesignAndCreation
+ summary: returns model
+ description: returns model
+ operationId: getServiceDesignAndCreationModelsModel
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/model"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-INVARIANT-ID__
+ - name: model-type
+ in: query
+ description: Type of the model, e.g., service, resource, widget, etc.
+ required: false
+ type: string
+ put:
+ tags:
+ - ServiceDesignAndCreation
+ summary: create or update an existing model
+ description: |
+ Create or update an existing model.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateServiceDesignAndCreationModelsModel
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-INVARIANT-ID__
+ - name: body
+ in: body
+ description: model object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModel.json)
+ required: true
+ schema:
+ $ref: "#/definitions/model"
+ patch:
+ tags:
+ - ServiceDesignAndCreation
+ summary: update an existing model
+ description: |
+ Update an existing model
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateServiceDesignAndCreationModelsModel
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-INVARIANT-ID__
+ - name: body
+ in: body
+ description: model object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/model"
+ delete:
+ tags:
+ - ServiceDesignAndCreation
+ summary: delete an existing model
+ description: delete an existing model
+ operationId: deleteServiceDesignAndCreationModelsModel
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ example: __MODEL-INVARIANT-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /service-design-and-creation/models:
+ get:
+ tags:
+ - ServiceDesignAndCreation
+ summary: returns models
+ description: returns models
+ operationId: getServiceDesignAndCreationModels
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/models"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /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:
+ tags:
+ - ServiceDesignAndCreation
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: named-query-uuid
+ in: path
+ required: true
+ type: string
+ example: __NAMED-QUERY-UUID__
+ - name: named-query-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __NAMED-QUERY-ELEMENT-UUID__
+ - name: related-lookup-uuid
+ in: path
+ required: true
+ type: string
+ example: __RELATED-LOOKUP-UUID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - ServiceDesignAndCreation
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: named-query-uuid
+ in: path
+ required: true
+ type: string
+ example: __NAMED-QUERY-UUID__
+ - name: named-query-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __NAMED-QUERY-ELEMENT-UUID__
+ - name: related-lookup-uuid
+ in: path
+ required: true
+ type: string
+ example: __RELATED-LOOKUP-UUID__
+ /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:
+ tags:
+ - ServiceDesignAndCreation
+ summary: returns related-lookup
+ description: returns related-lookup
+ operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/related-lookup"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: named-query-uuid
+ in: path
+ required: true
+ type: string
+ example: __NAMED-QUERY-UUID__
+ - name: named-query-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __NAMED-QUERY-ELEMENT-UUID__
+ - name: related-lookup-uuid
+ in: path
+ required: true
+ type: string
+ example: __RELATED-LOOKUP-UUID__
+ - name: named-query-name
+ in: query
+ required: false
+ type: string
+ put:
+ tags:
+ - ServiceDesignAndCreation
+ summary: create or update an existing related-lookup
+ description: |
+ Create or update an existing related-lookup.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: named-query-uuid
+ in: path
+ required: true
+ type: string
+ example: __NAMED-QUERY-UUID__
+ - name: named-query-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __NAMED-QUERY-ELEMENT-UUID__
+ - name: related-lookup-uuid
+ in: path
+ required: true
+ type: string
+ example: __RELATED-LOOKUP-UUID__
+ - name: body
+ in: body
+ description: related-lookup object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)
+ required: true
+ schema:
+ $ref: "#/definitions/related-lookup"
+ patch:
+ tags:
+ - ServiceDesignAndCreation
+ summary: update an existing related-lookup
+ description: |
+ Update an existing related-lookup
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: named-query-uuid
+ in: path
+ required: true
+ type: string
+ example: __NAMED-QUERY-UUID__
+ - name: named-query-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __NAMED-QUERY-ELEMENT-UUID__
+ - name: related-lookup-uuid
+ in: path
+ required: true
+ type: string
+ example: __RELATED-LOOKUP-UUID__
+ - name: body
+ in: body
+ description: related-lookup object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/related-lookup"
+ delete:
+ tags:
+ - ServiceDesignAndCreation
+ summary: delete an existing related-lookup
+ description: delete an existing related-lookup
+ operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: named-query-uuid
+ in: path
+ required: true
+ type: string
+ example: __NAMED-QUERY-UUID__
+ - name: named-query-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __NAMED-QUERY-ELEMENT-UUID__
+ - name: related-lookup-uuid
+ in: path
+ required: true
+ type: string
+ example: __RELATED-LOOKUP-UUID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups:
+ get:
+ tags:
+ - ServiceDesignAndCreation
+ summary: returns related-lookups
+ description: returns related-lookups
+ operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookups
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/related-lookups"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: named-query-uuid
+ in: path
+ required: true
+ type: string
+ example: __NAMED-QUERY-UUID__
+ - name: named-query-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __NAMED-QUERY-ELEMENT-UUID__
+ - name: named-query-name
+ in: query
+ required: false
+ type: string
+ /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:
+ tags:
+ - ServiceDesignAndCreation
+ summary: returns property-constraint
+ description: returns property-constraint
+ operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/property-constraint"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: named-query-uuid
+ in: path
+ required: true
+ type: string
+ example: __NAMED-QUERY-UUID__
+ - name: named-query-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __NAMED-QUERY-ELEMENT-UUID__
+ - name: property-constraint-uuid
+ in: path
+ required: true
+ type: string
+ example: __PROPERTY-CONSTRAINT-UUID__
+ - name: named-query-name
+ in: query
+ required: false
+ type: string
+ put:
+ tags:
+ - ServiceDesignAndCreation
+ summary: create or update an existing property-constraint
+ description: |
+ Create or update an existing property-constraint.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: named-query-uuid
+ in: path
+ required: true
+ type: string
+ example: __NAMED-QUERY-UUID__
+ - name: named-query-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __NAMED-QUERY-ELEMENT-UUID__
+ - name: property-constraint-uuid
+ in: path
+ required: true
+ type: string
+ example: __PROPERTY-CONSTRAINT-UUID__
+ - name: body
+ in: body
+ description: property-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint.json)
+ required: true
+ schema:
+ $ref: "#/definitions/property-constraint"
+ patch:
+ tags:
+ - ServiceDesignAndCreation
+ summary: update an existing property-constraint
+ description: |
+ Update an existing property-constraint
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: named-query-uuid
+ in: path
+ required: true
+ type: string
+ example: __NAMED-QUERY-UUID__
+ - name: named-query-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __NAMED-QUERY-ELEMENT-UUID__
+ - name: property-constraint-uuid
+ in: path
+ required: true
+ type: string
+ example: __PROPERTY-CONSTRAINT-UUID__
+ - name: body
+ in: body
+ description: property-constraint object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/property-constraint"
+ delete:
+ tags:
+ - ServiceDesignAndCreation
+ summary: delete an existing property-constraint
+ description: delete an existing property-constraint
+ operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: named-query-uuid
+ in: path
+ required: true
+ type: string
+ example: __NAMED-QUERY-UUID__
+ - name: named-query-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __NAMED-QUERY-ELEMENT-UUID__
+ - name: property-constraint-uuid
+ in: path
+ required: true
+ type: string
+ example: __PROPERTY-CONSTRAINT-UUID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints:
+ get:
+ tags:
+ - ServiceDesignAndCreation
+ summary: returns property-constraints
+ description: returns property-constraints
+ operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraints
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/property-constraints"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: named-query-uuid
+ in: path
+ required: true
+ type: string
+ example: __NAMED-QUERY-UUID__
+ - name: named-query-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __NAMED-QUERY-ELEMENT-UUID__
+ - name: named-query-name
+ in: query
+ required: false
+ type: string
+ /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:
+ tags:
+ - ServiceDesignAndCreation
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: named-query-uuid
+ in: path
+ required: true
+ type: string
+ example: __NAMED-QUERY-UUID__
+ - name: named-query-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __NAMED-QUERY-ELEMENT-UUID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - ServiceDesignAndCreation
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: named-query-uuid
+ in: path
+ required: true
+ type: string
+ example: __NAMED-QUERY-UUID__
+ - name: named-query-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __NAMED-QUERY-ELEMENT-UUID__
+ /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}:
+ get:
+ tags:
+ - ServiceDesignAndCreation
+ summary: returns named-query-element
+ description: returns named-query-element
+ operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/named-query-element"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: named-query-uuid
+ in: path
+ required: true
+ type: string
+ example: __NAMED-QUERY-UUID__
+ - name: named-query-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __NAMED-QUERY-ELEMENT-UUID__
+ - name: named-query-name
+ in: query
+ required: false
+ type: string
+ put:
+ tags:
+ - ServiceDesignAndCreation
+ summary: create or update an existing named-query-element
+ description: |
+ Create or update an existing named-query-element.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: named-query-uuid
+ in: path
+ required: true
+ type: string
+ example: __NAMED-QUERY-UUID__
+ - name: named-query-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __NAMED-QUERY-ELEMENT-UUID__
+ - name: body
+ in: body
+ description: named-query-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)
+ required: true
+ schema:
+ $ref: "#/definitions/named-query-element"
+ patch:
+ tags:
+ - ServiceDesignAndCreation
+ summary: update an existing named-query-element
+ description: |
+ Update an existing named-query-element
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: named-query-uuid
+ in: path
+ required: true
+ type: string
+ example: __NAMED-QUERY-UUID__
+ - name: named-query-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __NAMED-QUERY-ELEMENT-UUID__
+ - name: body
+ in: body
+ description: named-query-element object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/named-query-element"
+ delete:
+ tags:
+ - ServiceDesignAndCreation
+ summary: delete an existing named-query-element
+ description: delete an existing named-query-element
+ operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: named-query-uuid
+ in: path
+ required: true
+ type: string
+ example: __NAMED-QUERY-UUID__
+ - name: named-query-element-uuid
+ in: path
+ required: true
+ type: string
+ example: __NAMED-QUERY-ELEMENT-UUID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements:
+ get:
+ tags:
+ - ServiceDesignAndCreation
+ summary: returns named-query-elements
+ description: returns named-query-elements
+ operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElements
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/named-query-elements"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: named-query-uuid
+ in: path
+ required: true
+ type: string
+ example: __NAMED-QUERY-UUID__
+ - name: named-query-name
+ in: query
+ required: false
+ type: string
+ /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship:
+ put:
+ tags:
+ - ServiceDesignAndCreation
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: named-query-uuid
+ in: path
+ required: true
+ type: string
+ example: __NAMED-QUERY-UUID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQuery.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - ServiceDesignAndCreation
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: named-query-uuid
+ in: path
+ required: true
+ type: string
+ example: __NAMED-QUERY-UUID__
+ /service-design-and-creation/named-queries/named-query/{named-query-uuid}:
+ get:
+ tags:
+ - ServiceDesignAndCreation
+ summary: returns named-query
+ description: returns named-query
+ operationId: getServiceDesignAndCreationNamedQueriesNamedQuery
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/named-query"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: named-query-uuid
+ in: path
+ required: true
+ type: string
+ example: __NAMED-QUERY-UUID__
+ - name: named-query-name
+ in: query
+ required: false
+ type: string
+ put:
+ tags:
+ - ServiceDesignAndCreation
+ summary: create or update an existing named-query
+ description: |
+ Create or update an existing named-query.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQuery
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: named-query-uuid
+ in: path
+ required: true
+ type: string
+ example: __NAMED-QUERY-UUID__
+ - name: body
+ in: body
+ description: named-query object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQuery.json)
+ required: true
+ schema:
+ $ref: "#/definitions/named-query"
+ patch:
+ tags:
+ - ServiceDesignAndCreation
+ summary: update an existing named-query
+ description: |
+ Update an existing named-query
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQuery
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: named-query-uuid
+ in: path
+ required: true
+ type: string
+ example: __NAMED-QUERY-UUID__
+ - name: body
+ in: body
+ description: named-query object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/named-query"
+ delete:
+ tags:
+ - ServiceDesignAndCreation
+ summary: delete an existing named-query
+ description: delete an existing named-query
+ operationId: deleteServiceDesignAndCreationNamedQueriesNamedQuery
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: named-query-uuid
+ in: path
+ required: true
+ type: string
+ example: __NAMED-QUERY-UUID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /service-design-and-creation/named-queries:
+ get:
+ tags:
+ - ServiceDesignAndCreation
+ summary: returns named-queries
+ description: returns named-queries
+ operationId: getServiceDesignAndCreationNamedQueries
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/named-queries"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /network/logical-links/logical-link/{link-name}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkLogicalLinksLogicalLinkRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: link-name
+ in: path
+ description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
+ required: true
+ type: string
+ example: __LINK-NAME__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkLogicalLinksLogicalLink.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkLogicalLinksLogicalLinkRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: link-name
+ in: path
+ description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
+ required: true
+ type: string
+ example: __LINK-NAME__
+ /network/logical-links/logical-link/{link-name}:
+ get:
+ tags:
+ - Network
+ summary: returns logical-link
+ description: returns logical-link
+ operationId: getNetworkLogicalLinksLogicalLink
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/logical-link"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: link-name
+ in: path
+ description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
+ required: true
+ type: string
+ example: __LINK-NAME__
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ required: false
+ type: string
+ - name: link-id
+ in: query
+ description: UUID of the logical-link, SDNC generates this.
+ required: false
+ type: string
+ - name: circuit-id
+ in: query
+ description: Circuit id
+ required: false
+ type: string
+ - name: purpose
+ in: query
+ description: Reason for this entity, role it is playing
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing logical-link
+ description: |
+ Create or update an existing logical-link.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkLogicalLinksLogicalLink
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: link-name
+ in: path
+ description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
+ required: true
+ type: string
+ example: __LINK-NAME__
+ - name: body
+ in: body
+ description: logical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkLogicalLinksLogicalLink.json)
+ required: true
+ schema:
+ $ref: "#/definitions/logical-link"
+ patch:
+ tags:
+ - Network
+ summary: update an existing logical-link
+ description: |
+ Update an existing logical-link
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkLogicalLinksLogicalLink
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: link-name
+ in: path
+ description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
+ required: true
+ type: string
+ example: __LINK-NAME__
+ - name: body
+ in: body
+ description: logical-link object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/logical-link"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing logical-link
+ description: delete an existing logical-link
+ operationId: deleteNetworkLogicalLinksLogicalLink
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: link-name
+ in: path
+ description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
+ required: true
+ type: string
+ example: __LINK-NAME__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/logical-links:
+ get:
+ tags:
+ - Network
+ summary: returns logical-links
+ description: returns logical-links
+ operationId: getNetworkLogicalLinks
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/logical-links"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /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:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: site-pair-set-id
+ in: path
+ description: Unique id of site pair set.
+ required: true
+ type: string
+ example: __SITE-PAIR-SET-ID__
+ - name: routing-instance-id
+ in: path
+ description: Unique id of routing instance
+ required: true
+ type: string
+ example: __ROUTING-INSTANCE-ID__
+ - name: site-pair-id
+ in: path
+ description: unique identifier of probe
+ required: true
+ type: string
+ example: __SITE-PAIR-ID__
+ - name: cos
+ in: path
+ description: unique identifier of probe
+ required: true
+ type: string
+ example: __COS__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: site-pair-set-id
+ in: path
+ description: Unique id of site pair set.
+ required: true
+ type: string
+ example: __SITE-PAIR-SET-ID__
+ - name: routing-instance-id
+ in: path
+ description: Unique id of routing instance
+ required: true
+ type: string
+ example: __ROUTING-INSTANCE-ID__
+ - name: site-pair-id
+ in: path
+ description: unique identifier of probe
+ required: true
+ type: string
+ example: __SITE-PAIR-ID__
+ - name: cos
+ in: path
+ description: unique identifier of probe
+ required: true
+ type: string
+ example: __COS__
+ /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:
+ tags:
+ - Network
+ summary: returns class-of-service
+ description: returns class-of-service
+ operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/class-of-service"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: site-pair-set-id
+ in: path
+ description: Unique id of site pair set.
+ required: true
+ type: string
+ example: __SITE-PAIR-SET-ID__
+ - name: routing-instance-id
+ in: path
+ description: Unique id of routing instance
+ required: true
+ type: string
+ example: __ROUTING-INSTANCE-ID__
+ - name: site-pair-id
+ in: path
+ description: unique identifier of probe
+ required: true
+ type: string
+ example: __SITE-PAIR-ID__
+ - name: cos
+ in: path
+ description: unique identifier of probe
+ required: true
+ type: string
+ example: __COS__
+ put:
+ tags:
+ - Network
+ summary: create or update an existing class-of-service
+ description: |
+ Create or update an existing class-of-service.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: site-pair-set-id
+ in: path
+ description: Unique id of site pair set.
+ required: true
+ type: string
+ example: __SITE-PAIR-SET-ID__
+ - name: routing-instance-id
+ in: path
+ description: Unique id of routing instance
+ required: true
+ type: string
+ example: __ROUTING-INSTANCE-ID__
+ - name: site-pair-id
+ in: path
+ description: unique identifier of probe
+ required: true
+ type: string
+ example: __SITE-PAIR-ID__
+ - name: cos
+ in: path
+ description: unique identifier of probe
+ required: true
+ type: string
+ example: __COS__
+ - name: body
+ in: body
+ description: class-of-service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
+ required: true
+ schema:
+ $ref: "#/definitions/class-of-service"
+ patch:
+ tags:
+ - Network
+ summary: update an existing class-of-service
+ description: |
+ Update an existing class-of-service
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: site-pair-set-id
+ in: path
+ description: Unique id of site pair set.
+ required: true
+ type: string
+ example: __SITE-PAIR-SET-ID__
+ - name: routing-instance-id
+ in: path
+ description: Unique id of routing instance
+ required: true
+ type: string
+ example: __ROUTING-INSTANCE-ID__
+ - name: site-pair-id
+ in: path
+ description: unique identifier of probe
+ required: true
+ type: string
+ example: __SITE-PAIR-ID__
+ - name: cos
+ in: path
+ description: unique identifier of probe
+ required: true
+ type: string
+ example: __COS__
+ - name: body
+ in: body
+ description: class-of-service object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/class-of-service"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing class-of-service
+ description: delete an existing class-of-service
+ operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: site-pair-set-id
+ in: path
+ description: Unique id of site pair set.
+ required: true
+ type: string
+ example: __SITE-PAIR-SET-ID__
+ - name: routing-instance-id
+ in: path
+ description: Unique id of routing instance
+ required: true
+ type: string
+ example: __ROUTING-INSTANCE-ID__
+ - name: site-pair-id
+ in: path
+ description: unique identifier of probe
+ required: true
+ type: string
+ example: __SITE-PAIR-ID__
+ - name: cos
+ in: path
+ description: unique identifier of probe
+ required: true
+ type: string
+ example: __COS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /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:
+ tags:
+ - Network
+ summary: returns classes-of-service
+ description: returns classes-of-service
+ operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfService
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/classes-of-service"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: site-pair-set-id
+ in: path
+ description: Unique id of site pair set.
+ required: true
+ type: string
+ example: __SITE-PAIR-SET-ID__
+ - name: routing-instance-id
+ in: path
+ description: Unique id of routing instance
+ required: true
+ type: string
+ example: __ROUTING-INSTANCE-ID__
+ - name: site-pair-id
+ in: path
+ description: unique identifier of probe
+ required: true
+ type: string
+ example: __SITE-PAIR-ID__
+ /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:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: site-pair-set-id
+ in: path
+ description: Unique id of site pair set.
+ required: true
+ type: string
+ example: __SITE-PAIR-SET-ID__
+ - name: routing-instance-id
+ in: path
+ description: Unique id of routing instance
+ required: true
+ type: string
+ example: __ROUTING-INSTANCE-ID__
+ - name: site-pair-id
+ in: path
+ description: unique identifier of probe
+ required: true
+ type: string
+ example: __SITE-PAIR-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: site-pair-set-id
+ in: path
+ description: Unique id of site pair set.
+ required: true
+ type: string
+ example: __SITE-PAIR-SET-ID__
+ - name: routing-instance-id
+ in: path
+ description: Unique id of routing instance
+ required: true
+ type: string
+ example: __ROUTING-INSTANCE-ID__
+ - name: site-pair-id
+ in: path
+ description: unique identifier of probe
+ required: true
+ type: string
+ example: __SITE-PAIR-ID__
+ /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:
+ tags:
+ - Network
+ summary: returns site-pair
+ description: returns site-pair
+ operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/site-pair"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: site-pair-set-id
+ in: path
+ description: Unique id of site pair set.
+ required: true
+ type: string
+ example: __SITE-PAIR-SET-ID__
+ - name: routing-instance-id
+ in: path
+ description: Unique id of routing instance
+ required: true
+ type: string
+ example: __ROUTING-INSTANCE-ID__
+ - name: site-pair-id
+ in: path
+ description: unique identifier of probe
+ required: true
+ type: string
+ example: __SITE-PAIR-ID__
+ put:
+ tags:
+ - Network
+ summary: create or update an existing site-pair
+ description: |
+ Create or update an existing site-pair.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: site-pair-set-id
+ in: path
+ description: Unique id of site pair set.
+ required: true
+ type: string
+ example: __SITE-PAIR-SET-ID__
+ - name: routing-instance-id
+ in: path
+ description: Unique id of routing instance
+ required: true
+ type: string
+ example: __ROUTING-INSTANCE-ID__
+ - name: site-pair-id
+ in: path
+ description: unique identifier of probe
+ required: true
+ type: string
+ example: __SITE-PAIR-ID__
+ - name: body
+ in: body
+ description: site-pair object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)
+ required: true
+ schema:
+ $ref: "#/definitions/site-pair"
+ patch:
+ tags:
+ - Network
+ summary: update an existing site-pair
+ description: |
+ Update an existing site-pair
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: site-pair-set-id
+ in: path
+ description: Unique id of site pair set.
+ required: true
+ type: string
+ example: __SITE-PAIR-SET-ID__
+ - name: routing-instance-id
+ in: path
+ description: Unique id of routing instance
+ required: true
+ type: string
+ example: __ROUTING-INSTANCE-ID__
+ - name: site-pair-id
+ in: path
+ description: unique identifier of probe
+ required: true
+ type: string
+ example: __SITE-PAIR-ID__
+ - name: body
+ in: body
+ description: site-pair object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/site-pair"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing site-pair
+ description: delete an existing site-pair
+ operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: site-pair-set-id
+ in: path
+ description: Unique id of site pair set.
+ required: true
+ type: string
+ example: __SITE-PAIR-SET-ID__
+ - name: routing-instance-id
+ in: path
+ description: Unique id of routing instance
+ required: true
+ type: string
+ example: __ROUTING-INSTANCE-ID__
+ - name: site-pair-id
+ in: path
+ description: unique identifier of probe
+ required: true
+ type: string
+ example: __SITE-PAIR-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs:
+ get:
+ tags:
+ - Network
+ summary: returns site-pairs
+ description: returns site-pairs
+ operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairs
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/site-pairs"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: site-pair-set-id
+ in: path
+ description: Unique id of site pair set.
+ required: true
+ type: string
+ example: __SITE-PAIR-SET-ID__
+ - name: routing-instance-id
+ in: path
+ description: Unique id of routing instance
+ required: true
+ type: string
+ example: __ROUTING-INSTANCE-ID__
+ /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: site-pair-set-id
+ in: path
+ description: Unique id of site pair set.
+ required: true
+ type: string
+ example: __SITE-PAIR-SET-ID__
+ - name: routing-instance-id
+ in: path
+ description: Unique id of routing instance
+ required: true
+ type: string
+ example: __ROUTING-INSTANCE-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: site-pair-set-id
+ in: path
+ description: Unique id of site pair set.
+ required: true
+ type: string
+ example: __SITE-PAIR-SET-ID__
+ - name: routing-instance-id
+ in: path
+ description: Unique id of routing instance
+ required: true
+ type: string
+ example: __ROUTING-INSTANCE-ID__
+ /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}:
+ get:
+ tags:
+ - Network
+ summary: returns routing-instance
+ description: returns routing-instance
+ operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/routing-instance"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: site-pair-set-id
+ in: path
+ description: Unique id of site pair set.
+ required: true
+ type: string
+ example: __SITE-PAIR-SET-ID__
+ - name: routing-instance-id
+ in: path
+ description: Unique id of routing instance
+ required: true
+ type: string
+ example: __ROUTING-INSTANCE-ID__
+ put:
+ tags:
+ - Network
+ summary: create or update an existing routing-instance
+ description: |
+ Create or update an existing routing-instance.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: site-pair-set-id
+ in: path
+ description: Unique id of site pair set.
+ required: true
+ type: string
+ example: __SITE-PAIR-SET-ID__
+ - name: routing-instance-id
+ in: path
+ description: Unique id of routing instance
+ required: true
+ type: string
+ example: __ROUTING-INSTANCE-ID__
+ - name: body
+ in: body
+ description: routing-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)
+ required: true
+ schema:
+ $ref: "#/definitions/routing-instance"
+ patch:
+ tags:
+ - Network
+ summary: update an existing routing-instance
+ description: |
+ Update an existing routing-instance
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: site-pair-set-id
+ in: path
+ description: Unique id of site pair set.
+ required: true
+ type: string
+ example: __SITE-PAIR-SET-ID__
+ - name: routing-instance-id
+ in: path
+ description: Unique id of routing instance
+ required: true
+ type: string
+ example: __ROUTING-INSTANCE-ID__
+ - name: body
+ in: body
+ description: routing-instance object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/routing-instance"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing routing-instance
+ description: delete an existing routing-instance
+ operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: site-pair-set-id
+ in: path
+ description: Unique id of site pair set.
+ required: true
+ type: string
+ example: __SITE-PAIR-SET-ID__
+ - name: routing-instance-id
+ in: path
+ description: Unique id of routing instance
+ required: true
+ type: string
+ example: __ROUTING-INSTANCE-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances:
+ get:
+ tags:
+ - Network
+ summary: returns routing-instances
+ description: returns routing-instances
+ operationId: getNetworkSitePairSetsSitePairSetRoutingInstances
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/routing-instances"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: site-pair-set-id
+ in: path
+ description: Unique id of site pair set.
+ required: true
+ type: string
+ example: __SITE-PAIR-SET-ID__
+ /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkSitePairSetsSitePairSetRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: site-pair-set-id
+ in: path
+ description: Unique id of site pair set.
+ required: true
+ type: string
+ example: __SITE-PAIR-SET-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSet.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkSitePairSetsSitePairSetRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: site-pair-set-id
+ in: path
+ description: Unique id of site pair set.
+ required: true
+ type: string
+ example: __SITE-PAIR-SET-ID__
+ /network/site-pair-sets/site-pair-set/{site-pair-set-id}:
+ get:
+ tags:
+ - Network
+ summary: returns site-pair-set
+ description: returns site-pair-set
+ operationId: getNetworkSitePairSetsSitePairSet
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/site-pair-set"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: site-pair-set-id
+ in: path
+ description: Unique id of site pair set.
+ required: true
+ type: string
+ example: __SITE-PAIR-SET-ID__
+ put:
+ tags:
+ - Network
+ summary: create or update an existing site-pair-set
+ description: |
+ Create or update an existing site-pair-set.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkSitePairSetsSitePairSet
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: site-pair-set-id
+ in: path
+ description: Unique id of site pair set.
+ required: true
+ type: string
+ example: __SITE-PAIR-SET-ID__
+ - name: body
+ in: body
+ description: site-pair-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSet.json)
+ required: true
+ schema:
+ $ref: "#/definitions/site-pair-set"
+ patch:
+ tags:
+ - Network
+ summary: update an existing site-pair-set
+ description: |
+ Update an existing site-pair-set
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkSitePairSetsSitePairSet
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: site-pair-set-id
+ in: path
+ description: Unique id of site pair set.
+ required: true
+ type: string
+ example: __SITE-PAIR-SET-ID__
+ - name: body
+ in: body
+ description: site-pair-set object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/site-pair-set"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing site-pair-set
+ description: delete an existing site-pair-set
+ operationId: deleteNetworkSitePairSetsSitePairSet
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: site-pair-set-id
+ in: path
+ description: Unique id of site pair set.
+ required: true
+ type: string
+ example: __SITE-PAIR-SET-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/site-pair-sets:
+ get:
+ tags:
+ - Network
+ summary: returns site-pair-sets
+ description: returns site-pair-sets
+ operationId: getNetworkSitePairSets
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/site-pair-sets"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vpn-id
+ in: path
+ description: VPN ID, globally unique within A&AI
+ required: true
+ type: string
+ example: __VPN-ID__
+ - name: global-route-target
+ in: path
+ description: Number used to identify an RT, globally unique in the network
+ required: true
+ type: string
+ example: __GLOBAL-ROUTE-TARGET__
+ - name: route-target-role
+ in: path
+ description: Role assigned to this route target
+ required: true
+ type: string
+ example: __ROUTE-TARGET-ROLE__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vpn-id
+ in: path
+ description: VPN ID, globally unique within A&AI
+ required: true
+ type: string
+ example: __VPN-ID__
+ - name: global-route-target
+ in: path
+ description: Number used to identify an RT, globally unique in the network
+ required: true
+ type: string
+ example: __GLOBAL-ROUTE-TARGET__
+ - name: route-target-role
+ in: path
+ description: Role assigned to this route target
+ required: true
+ type: string
+ example: __ROUTE-TARGET-ROLE__
+ /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}:
+ get:
+ tags:
+ - Network
+ summary: returns route-target
+ description: returns route-target
+ operationId: getNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/route-target"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vpn-id
+ in: path
+ description: VPN ID, globally unique within A&AI
+ required: true
+ type: string
+ example: __VPN-ID__
+ - name: global-route-target
+ in: path
+ description: Number used to identify an RT, globally unique in the network
+ required: true
+ type: string
+ example: __GLOBAL-ROUTE-TARGET__
+ - name: route-target-role
+ in: path
+ description: Role assigned to this route target
+ required: true
+ type: string
+ example: __ROUTE-TARGET-ROLE__
+ - name: vpn-name
+ in: query
+ description: VPN Name
+ required: false
+ type: string
+ - name: vpn-type
+ in: query
+ description: Type of the vpn, should be taken from enumerated/valid values
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing route-target
+ description: |
+ Create or update an existing route-target.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vpn-id
+ in: path
+ description: VPN ID, globally unique within A&AI
+ required: true
+ type: string
+ example: __VPN-ID__
+ - name: global-route-target
+ in: path
+ description: Number used to identify an RT, globally unique in the network
+ required: true
+ type: string
+ example: __GLOBAL-ROUTE-TARGET__
+ - name: route-target-role
+ in: path
+ description: Role assigned to this route target
+ required: true
+ type: string
+ example: __ROUTE-TARGET-ROLE__
+ - name: body
+ in: body
+ description: route-target object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json)
+ required: true
+ schema:
+ $ref: "#/definitions/route-target"
+ patch:
+ tags:
+ - Network
+ summary: update an existing route-target
+ description: |
+ Update an existing route-target
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vpn-id
+ in: path
+ description: VPN ID, globally unique within A&AI
+ required: true
+ type: string
+ example: __VPN-ID__
+ - name: global-route-target
+ in: path
+ description: Number used to identify an RT, globally unique in the network
+ required: true
+ type: string
+ example: __GLOBAL-ROUTE-TARGET__
+ - name: route-target-role
+ in: path
+ description: Role assigned to this route target
+ required: true
+ type: string
+ example: __ROUTE-TARGET-ROLE__
+ - name: body
+ in: body
+ description: route-target object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/route-target"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing route-target
+ description: delete an existing route-target
+ operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vpn-id
+ in: path
+ description: VPN ID, globally unique within A&AI
+ required: true
+ type: string
+ example: __VPN-ID__
+ - name: global-route-target
+ in: path
+ description: Number used to identify an RT, globally unique in the network
+ required: true
+ type: string
+ example: __GLOBAL-ROUTE-TARGET__
+ - name: route-target-role
+ in: path
+ description: Role assigned to this route target
+ required: true
+ type: string
+ example: __ROUTE-TARGET-ROLE__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets:
+ get:
+ tags:
+ - Network
+ summary: returns route-targets
+ description: returns route-targets
+ operationId: getNetworkVpnBindingsVpnBindingRouteTargets
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/route-targets"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vpn-id
+ in: path
+ description: VPN ID, globally unique within A&AI
+ required: true
+ type: string
+ example: __VPN-ID__
+ - name: vpn-name
+ in: query
+ description: VPN Name
+ required: false
+ type: string
+ - name: vpn-type
+ in: query
+ description: Type of the vpn, should be taken from enumerated/valid values
+ required: false
+ type: string
+ /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVpnBindingsVpnBindingRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vpn-id
+ in: path
+ description: VPN ID, globally unique within A&AI
+ required: true
+ type: string
+ example: __VPN-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVpnBindingsVpnBinding.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkVpnBindingsVpnBindingRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vpn-id
+ in: path
+ description: VPN ID, globally unique within A&AI
+ required: true
+ type: string
+ example: __VPN-ID__
+ /network/vpn-bindings/vpn-binding/{vpn-id}:
+ get:
+ tags:
+ - Network
+ summary: returns vpn-binding
+ description: returns vpn-binding
+ operationId: getNetworkVpnBindingsVpnBinding
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/vpn-binding"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vpn-id
+ in: path
+ description: VPN ID, globally unique within A&AI
+ required: true
+ type: string
+ example: __VPN-ID__
+ - name: vpn-name
+ in: query
+ description: VPN Name
+ required: false
+ type: string
+ - name: vpn-type
+ in: query
+ description: Type of the vpn, should be taken from enumerated/valid values
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing vpn-binding
+ description: |
+ Create or update an existing vpn-binding.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkVpnBindingsVpnBinding
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vpn-id
+ in: path
+ description: VPN ID, globally unique within A&AI
+ required: true
+ type: string
+ example: __VPN-ID__
+ - name: body
+ in: body
+ description: vpn-binding object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVpnBindingsVpnBinding.json)
+ required: true
+ schema:
+ $ref: "#/definitions/vpn-binding"
+ patch:
+ tags:
+ - Network
+ summary: update an existing vpn-binding
+ description: |
+ Update an existing vpn-binding
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkVpnBindingsVpnBinding
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vpn-id
+ in: path
+ description: VPN ID, globally unique within A&AI
+ required: true
+ type: string
+ example: __VPN-ID__
+ - name: body
+ in: body
+ description: vpn-binding object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/vpn-binding"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing vpn-binding
+ description: delete an existing vpn-binding
+ operationId: deleteNetworkVpnBindingsVpnBinding
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vpn-id
+ in: path
+ description: VPN ID, globally unique within A&AI
+ required: true
+ type: string
+ example: __VPN-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/vpn-bindings:
+ get:
+ tags:
+ - Network
+ summary: returns vpn-bindings
+ description: returns vpn-bindings
+ operationId: getNetworkVpnBindings
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/vpn-bindings"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVplsPesVplsPeRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPe.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkVplsPesVplsPeRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterface.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pf-pci-id
+ in: path
+ description: Identifier for the sriov-pf
+ required: true
+ type: string
+ example: __PF-PCI-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pf-pci-id
+ in: path
+ description: Identifier for the sriov-pf
+ required: true
+ type: string
+ example: __PF-PCI-ID__
+ /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}:
+ get:
+ tags:
+ - Network
+ summary: returns sriov-pf
+ description: returns sriov-pf
+ operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/sriov-pf"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pf-pci-id
+ in: path
+ description: Identifier for the sriov-pf
+ required: true
+ type: string
+ example: __PF-PCI-ID__
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing sriov-pf
+ description: |
+ Create or update an existing sriov-pf.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pf-pci-id
+ in: path
+ description: Identifier for the sriov-pf
+ required: true
+ type: string
+ example: __PF-PCI-ID__
+ - name: body
+ in: body
+ description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf.json)
+ required: true
+ schema:
+ $ref: "#/definitions/sriov-pf"
+ patch:
+ tags:
+ - Network
+ summary: update an existing sriov-pf
+ description: |
+ Update an existing sriov-pf
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pf-pci-id
+ in: path
+ description: Identifier for the sriov-pf
+ required: true
+ type: string
+ example: __PF-PCI-ID__
+ - name: body
+ in: body
+ description: sriov-pf object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/sriov-pf"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing sriov-pf
+ description: delete an existing sriov-pf
+ operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pf-pci-id
+ in: path
+ description: Identifier for the sriov-pf
+ required: true
+ type: string
+ example: __PF-PCI-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs:
+ get:
+ tags:
+ - Network
+ summary: returns sriov-pfs
+ description: returns sriov-pfs
+ operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfs
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/sriov-pfs"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ /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:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ /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:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ /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:
+ tags:
+ - Network
+ summary: returns l3-interface-ipv4-address-list
+ description: returns l3-interface-ipv4-address-list
+ operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: vpn-key
+ in: query
+ description: This indicates the customers VPN ID associated with this vlan
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface that address belongs to
+ required: false
+ type: string
+ - name: neutron-subnet-id
+ in: query
+ description: Neutron id of subnet that address belongs to
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing l3-interface-ipv4-address-list
+ description: |
+ Create or update an existing l3-interface-ipv4-address-list.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv4-address-list"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l3-interface-ipv4-address-list
+ description: |
+ Update an existing l3-interface-ipv4-address-list
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing l3-interface-ipv4-address-list
+ description: delete an existing l3-interface-ipv4-address-list
+ operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /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:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ /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:
+ tags:
+ - Network
+ summary: returns l3-interface-ipv6-address-list
+ description: returns l3-interface-ipv6-address-list
+ operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: vpn-key
+ in: query
+ description: This indicates the customers VPN ID associated with this vlan
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface that address belongs to
+ required: false
+ type: string
+ - name: neutron-subnet-id
+ in: query
+ description: Neutron id of subnet that address belongs to
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing l3-interface-ipv6-address-list
+ description: |
+ Create or update an existing l3-interface-ipv6-address-list.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l3-interface-ipv6-address-list
+ description: |
+ Update an existing l3-interface-ipv6-address-list
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing l3-interface-ipv6-address-list
+ description: delete an existing l3-interface-ipv6-address-list
+ operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
+ get:
+ tags:
+ - Network
+ summary: returns vlan
+ description: returns vlan
+ operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/vlan"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: vpn-key
+ in: query
+ description: This indicates the customers VPN ID associated with this vlan
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing vlan
+ description: |
+ Create or update an existing vlan.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: body
+ in: body
+ description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
+ required: true
+ schema:
+ $ref: "#/definitions/vlan"
+ patch:
+ tags:
+ - Network
+ summary: update an existing vlan
+ description: |
+ Update an existing vlan
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: body
+ in: body
+ description: vlan object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/vlan"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing vlan
+ description: delete an existing vlan
+ operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
+ get:
+ tags:
+ - Network
+ summary: returns vlans
+ description: returns vlans
+ operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlans
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/vlans"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ /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:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ /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:
+ tags:
+ - Network
+ summary: returns sriov-vf
+ description: returns sriov-vf
+ operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/sriov-vf"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vf-vlan-filter
+ in: query
+ description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
+ required: false
+ type: string
+ - name: vf-mac-filter
+ in: query
+ description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
+ required: false
+ type: string
+ - name: vf-vlan-strip
+ in: query
+ description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
+ required: false
+ type: boolean
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing sriov-vf
+ description: |
+ Create or update an existing sriov-vf.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: body
+ in: body
+ description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
+ required: true
+ schema:
+ $ref: "#/definitions/sriov-vf"
+ patch:
+ tags:
+ - Network
+ summary: update an existing sriov-vf
+ description: |
+ Update an existing sriov-vf
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: body
+ in: body
+ description: sriov-vf object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/sriov-vf"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing sriov-vf
+ description: delete an existing sriov-vf
+ operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
+ get:
+ tags:
+ - Network
+ summary: returns sriov-vfs
+ description: returns sriov-vfs
+ operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/sriov-vfs"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ /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:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ /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:
+ tags:
+ - Network
+ summary: returns l3-interface-ipv4-address-list
+ description: returns l3-interface-ipv4-address-list
+ operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface that address belongs to
+ required: false
+ type: string
+ - name: neutron-subnet-id
+ in: query
+ description: Neutron id of subnet that address belongs to
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing l3-interface-ipv4-address-list
+ description: |
+ Create or update an existing l3-interface-ipv4-address-list.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv4-address-list"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l3-interface-ipv4-address-list
+ description: |
+ Update an existing l3-interface-ipv4-address-list
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing l3-interface-ipv4-address-list
+ description: delete an existing l3-interface-ipv4-address-list
+ operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /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:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ /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:
+ tags:
+ - Network
+ summary: returns l3-interface-ipv6-address-list
+ description: returns l3-interface-ipv6-address-list
+ operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface that address belongs to
+ required: false
+ type: string
+ - name: neutron-subnet-id
+ in: query
+ description: Neutron id of subnet that address belongs to
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing l3-interface-ipv6-address-list
+ description: |
+ Create or update an existing l3-interface-ipv6-address-list.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l3-interface-ipv6-address-list
+ description: |
+ Update an existing l3-interface-ipv6-address-list
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing l3-interface-ipv6-address-list
+ description: delete an existing l3-interface-ipv6-address-list
+ operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
+ get:
+ tags:
+ - Network
+ summary: returns l-interface
+ description: returns l-interface
+ operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l-interface"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing l-interface
+ description: |
+ Create or update an existing l-interface.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l-interface"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l-interface
+ description: |
+ Update an existing l-interface
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: l-interface object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l-interface"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing l-interface
+ description: delete an existing l-interface
+ operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces:
+ get:
+ tags:
+ - Network
+ summary: returns l-interfaces
+ description: returns l-interfaces
+ operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfaces
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l-interfaces"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}:
+ get:
+ tags:
+ - Network
+ summary: returns p-interface
+ description: returns p-interface
+ operationId: getNetworkVplsPesVplsPePInterfacesPInterface
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/p-interface"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing p-interface
+ description: |
+ Create or update an existing p-interface.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterface.json)
+ required: true
+ schema:
+ $ref: "#/definitions/p-interface"
+ patch:
+ tags:
+ - Network
+ summary: update an existing p-interface
+ description: |
+ Update an existing p-interface
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: p-interface object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/p-interface"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing p-interface
+ description: delete an existing p-interface
+ operationId: deleteNetworkVplsPesVplsPePInterfacesPInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces:
+ get:
+ tags:
+ - Network
+ summary: returns p-interfaces
+ description: returns p-interfaces
+ operationId: getNetworkVplsPesVplsPePInterfaces
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/p-interfaces"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ required: false
+ type: string
+ /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ /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:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ /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:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ /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:
+ tags:
+ - Network
+ summary: returns l3-interface-ipv4-address-list
+ description: returns l3-interface-ipv4-address-list
+ operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: vpn-key
+ in: query
+ description: This indicates the customers VPN ID associated with this vlan
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface that address belongs to
+ required: false
+ type: string
+ - name: neutron-subnet-id
+ in: query
+ description: Neutron id of subnet that address belongs to
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing l3-interface-ipv4-address-list
+ description: |
+ Create or update an existing l3-interface-ipv4-address-list.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv4-address-list"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l3-interface-ipv4-address-list
+ description: |
+ Update an existing l3-interface-ipv4-address-list
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing l3-interface-ipv4-address-list
+ description: delete an existing l3-interface-ipv4-address-list
+ operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /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:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ /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:
+ tags:
+ - Network
+ summary: returns l3-interface-ipv6-address-list
+ description: returns l3-interface-ipv6-address-list
+ operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: vpn-key
+ in: query
+ description: This indicates the customers VPN ID associated with this vlan
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface that address belongs to
+ required: false
+ type: string
+ - name: neutron-subnet-id
+ in: query
+ description: Neutron id of subnet that address belongs to
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing l3-interface-ipv6-address-list
+ description: |
+ Create or update an existing l3-interface-ipv6-address-list.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l3-interface-ipv6-address-list
+ description: |
+ Update an existing l3-interface-ipv6-address-list
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing l3-interface-ipv6-address-list
+ description: delete an existing l3-interface-ipv6-address-list
+ operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
+ get:
+ tags:
+ - Network
+ summary: returns vlan
+ description: returns vlan
+ operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/vlan"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: vpn-key
+ in: query
+ description: This indicates the customers VPN ID associated with this vlan
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing vlan
+ description: |
+ Create or update an existing vlan.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: body
+ in: body
+ description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
+ required: true
+ schema:
+ $ref: "#/definitions/vlan"
+ patch:
+ tags:
+ - Network
+ summary: update an existing vlan
+ description: |
+ Update an existing vlan
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: body
+ in: body
+ description: vlan object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/vlan"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing vlan
+ description: delete an existing vlan
+ operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
+ get:
+ tags:
+ - Network
+ summary: returns vlans
+ description: returns vlans
+ operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/vlans"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ /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:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ /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:
+ tags:
+ - Network
+ summary: returns sriov-vf
+ description: returns sriov-vf
+ operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/sriov-vf"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vf-vlan-filter
+ in: query
+ description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
+ required: false
+ type: string
+ - name: vf-mac-filter
+ in: query
+ description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
+ required: false
+ type: string
+ - name: vf-vlan-strip
+ in: query
+ description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
+ required: false
+ type: boolean
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing sriov-vf
+ description: |
+ Create or update an existing sriov-vf.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: body
+ in: body
+ description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
+ required: true
+ schema:
+ $ref: "#/definitions/sriov-vf"
+ patch:
+ tags:
+ - Network
+ summary: update an existing sriov-vf
+ description: |
+ Update an existing sriov-vf
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: body
+ in: body
+ description: sriov-vf object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/sriov-vf"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing sriov-vf
+ description: delete an existing sriov-vf
+ operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
+ get:
+ tags:
+ - Network
+ summary: returns sriov-vfs
+ description: returns sriov-vfs
+ operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/sriov-vfs"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ /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:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ /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:
+ tags:
+ - Network
+ summary: returns l3-interface-ipv4-address-list
+ description: returns l3-interface-ipv4-address-list
+ operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface that address belongs to
+ required: false
+ type: string
+ - name: neutron-subnet-id
+ in: query
+ description: Neutron id of subnet that address belongs to
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing l3-interface-ipv4-address-list
+ description: |
+ Create or update an existing l3-interface-ipv4-address-list.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv4-address-list"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l3-interface-ipv4-address-list
+ description: |
+ Update an existing l3-interface-ipv4-address-list
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing l3-interface-ipv4-address-list
+ description: delete an existing l3-interface-ipv4-address-list
+ operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /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:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ /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:
+ tags:
+ - Network
+ summary: returns l3-interface-ipv6-address-list
+ description: returns l3-interface-ipv6-address-list
+ operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface that address belongs to
+ required: false
+ type: string
+ - name: neutron-subnet-id
+ in: query
+ description: Neutron id of subnet that address belongs to
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing l3-interface-ipv6-address-list
+ description: |
+ Create or update an existing l3-interface-ipv6-address-list.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l3-interface-ipv6-address-list
+ description: |
+ Update an existing l3-interface-ipv6-address-list
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing l3-interface-ipv6-address-list
+ description: delete an existing l3-interface-ipv6-address-list
+ operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
+ get:
+ tags:
+ - Network
+ summary: returns l-interface
+ description: returns l-interface
+ operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l-interface"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing l-interface
+ description: |
+ Create or update an existing l-interface.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l-interface"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l-interface
+ description: |
+ Update an existing l-interface
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: l-interface object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l-interface"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing l-interface
+ description: delete an existing l-interface
+ operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
+ get:
+ tags:
+ - Network
+ summary: returns l-interfaces
+ description: returns l-interfaces
+ operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfaces
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l-interfaces"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ required: false
+ type: string
+ /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}:
+ get:
+ tags:
+ - Network
+ summary: returns lag-interface
+ description: returns lag-interface
+ operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterface
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/lag-interface"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing lag-interface
+ description: |
+ Create or update an existing lag-interface.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)
+ required: true
+ schema:
+ $ref: "#/definitions/lag-interface"
+ patch:
+ tags:
+ - Network
+ summary: update an existing lag-interface
+ description: |
+ Update an existing lag-interface
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: lag-interface object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/lag-interface"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing lag-interface
+ description: delete an existing lag-interface
+ operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces:
+ get:
+ tags:
+ - Network
+ summary: returns lag-interfaces
+ description: returns lag-interfaces
+ operationId: getNetworkVplsPesVplsPeLagInterfaces
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/lag-interfaces"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ required: false
+ type: string
+ /network/vpls-pes/vpls-pe/{equipment-name}:
+ get:
+ tags:
+ - Network
+ summary: returns vpls-pe
+ description: returns vpls-pe
+ operationId: getNetworkVplsPesVplsPe
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/vpls-pe"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing vpls-pe
+ description: |
+ Create or update an existing vpls-pe.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkVplsPesVplsPe
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: body
+ in: body
+ description: vpls-pe object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPe.json)
+ required: true
+ schema:
+ $ref: "#/definitions/vpls-pe"
+ patch:
+ tags:
+ - Network
+ summary: update an existing vpls-pe
+ description: |
+ Update an existing vpls-pe
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkVplsPesVplsPe
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: body
+ in: body
+ description: vpls-pe object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/vpls-pe"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing vpls-pe
+ description: delete an existing vpls-pe
+ operationId: deleteNetworkVplsPesVplsPe
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: equipment-name
+ in: path
+ required: true
+ type: string
+ example: __EQUIPMENT-NAME__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/vpls-pes:
+ get:
+ tags:
+ - Network
+ summary: returns vpls-pes
+ description: returns vpls-pes
+ operationId: getNetworkVplsPes
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/vpls-pes"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: multicast-configuration-id
+ in: path
+ description: Unique id of multicast configuration.
+ required: true
+ type: string
+ example: __MULTICAST-CONFIGURATION-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkMulticastConfigurationsMulticastConfiguration.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: multicast-configuration-id
+ in: path
+ description: Unique id of multicast configuration.
+ required: true
+ type: string
+ example: __MULTICAST-CONFIGURATION-ID__
+ /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}:
+ get:
+ tags:
+ - Network
+ summary: returns multicast-configuration
+ description: returns multicast-configuration
+ operationId: getNetworkMulticastConfigurationsMulticastConfiguration
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/multicast-configuration"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: multicast-configuration-id
+ in: path
+ description: Unique id of multicast configuration.
+ required: true
+ type: string
+ example: __MULTICAST-CONFIGURATION-ID__
+ put:
+ tags:
+ - Network
+ summary: create or update an existing multicast-configuration
+ description: |
+ Create or update an existing multicast-configuration.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfiguration
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: multicast-configuration-id
+ in: path
+ description: Unique id of multicast configuration.
+ required: true
+ type: string
+ example: __MULTICAST-CONFIGURATION-ID__
+ - name: body
+ in: body
+ description: multicast-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkMulticastConfigurationsMulticastConfiguration.json)
+ required: true
+ schema:
+ $ref: "#/definitions/multicast-configuration"
+ patch:
+ tags:
+ - Network
+ summary: update an existing multicast-configuration
+ description: |
+ Update an existing multicast-configuration
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkMulticastConfigurationsMulticastConfiguration
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: multicast-configuration-id
+ in: path
+ description: Unique id of multicast configuration.
+ required: true
+ type: string
+ example: __MULTICAST-CONFIGURATION-ID__
+ - name: body
+ in: body
+ description: multicast-configuration object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/multicast-configuration"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing multicast-configuration
+ description: delete an existing multicast-configuration
+ operationId: deleteNetworkMulticastConfigurationsMulticastConfiguration
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: multicast-configuration-id
+ in: path
+ description: Unique id of multicast configuration.
+ required: true
+ type: string
+ example: __MULTICAST-CONFIGURATION-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/multicast-configurations:
+ get:
+ tags:
+ - Network
+ summary: returns multicast-configurations
+ description: returns multicast-configurations
+ operationId: getNetworkMulticastConfigurations
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/multicast-configurations"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-id
+ in: path
+ description: Unique ID of the interface
+ required: true
+ type: string
+ example: __INTERFACE-ID__
+ - name: cvlan-tag
+ in: path
+ description: See mis-na-virtualization-platform.yang
+ required: true
+ type: integer
+ format: int64
+ example: __CVLAN-TAG__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-id
+ in: path
+ description: Unique ID of the interface
+ required: true
+ type: string
+ example: __INTERFACE-ID__
+ - name: cvlan-tag
+ in: path
+ description: See mis-na-virtualization-platform.yang
+ required: true
+ type: integer
+ format: int64
+ example: __CVLAN-TAG__
+ /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}:
+ get:
+ tags:
+ - Network
+ summary: returns cvlan-tag-entry
+ description: returns cvlan-tag-entry
+ operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/cvlan-tag-entry"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-id
+ in: path
+ description: Unique ID of the interface
+ required: true
+ type: string
+ example: __INTERFACE-ID__
+ - name: cvlan-tag
+ in: path
+ description: See mis-na-virtualization-platform.yang
+ required: true
+ type: integer
+ format: int64
+ example: __CVLAN-TAG__
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
+ required: false
+ type: string
+ - name: regional-resource-zone
+ in: query
+ description: Regional way of organizing pservers, source of truth should define values
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: vpe-id
+ in: query
+ description: Unique ID of VPE connected to this VCE.
+ required: false
+ type: string
+ - name: port-group-id
+ in: query
+ description: Unique ID for port group in vmware
+ required: false
+ type: string
+ - name: switch-name
+ in: query
+ description: DVS or standard switch name (should be non-null for port groups associated with DVS)
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing cvlan-tag-entry
+ description: |
+ Create or update an existing cvlan-tag-entry.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-id
+ in: path
+ description: Unique ID of the interface
+ required: true
+ type: string
+ example: __INTERFACE-ID__
+ - name: cvlan-tag
+ in: path
+ description: See mis-na-virtualization-platform.yang
+ required: true
+ type: integer
+ format: int64
+ example: __CVLAN-TAG__
+ - name: body
+ in: body
+ description: cvlan-tag-entry object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)
+ required: true
+ schema:
+ $ref: "#/definitions/cvlan-tag-entry"
+ patch:
+ tags:
+ - Network
+ summary: update an existing cvlan-tag-entry
+ description: |
+ Update an existing cvlan-tag-entry
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-id
+ in: path
+ description: Unique ID of the interface
+ required: true
+ type: string
+ example: __INTERFACE-ID__
+ - name: cvlan-tag
+ in: path
+ description: See mis-na-virtualization-platform.yang
+ required: true
+ type: integer
+ format: int64
+ example: __CVLAN-TAG__
+ - name: body
+ in: body
+ description: cvlan-tag-entry object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/cvlan-tag-entry"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing cvlan-tag-entry
+ description: delete an existing cvlan-tag-entry
+ operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-id
+ in: path
+ description: Unique ID of the interface
+ required: true
+ type: string
+ example: __INTERFACE-ID__
+ - name: cvlan-tag
+ in: path
+ description: See mis-na-virtualization-platform.yang
+ required: true
+ type: integer
+ format: int64
+ example: __CVLAN-TAG__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags:
+ get:
+ tags:
+ - Network
+ summary: returns cvlan-tags
+ description: returns cvlan-tags
+ operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTags
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/cvlan-tags"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-id
+ in: path
+ description: Unique ID of the interface
+ required: true
+ type: string
+ example: __INTERFACE-ID__
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
+ required: false
+ type: string
+ - name: regional-resource-zone
+ in: query
+ description: Regional way of organizing pservers, source of truth should define values
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: vpe-id
+ in: query
+ description: Unique ID of VPE connected to this VCE.
+ required: false
+ type: string
+ - name: port-group-id
+ in: query
+ description: Unique ID for port group in vmware
+ required: false
+ type: string
+ - name: switch-name
+ in: query
+ description: DVS or standard switch name (should be non-null for port groups associated with DVS)
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-id
+ in: path
+ description: Unique ID of the interface
+ required: true
+ type: string
+ example: __INTERFACE-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVcePortGroupsPortGroup.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-id
+ in: path
+ description: Unique ID of the interface
+ required: true
+ type: string
+ example: __INTERFACE-ID__
+ /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}:
+ get:
+ tags:
+ - Network
+ summary: returns port-group
+ description: returns port-group
+ operationId: getNetworkVcesVcePortGroupsPortGroup
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/port-group"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-id
+ in: path
+ description: Unique ID of the interface
+ required: true
+ type: string
+ example: __INTERFACE-ID__
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
+ required: false
+ type: string
+ - name: regional-resource-zone
+ in: query
+ description: Regional way of organizing pservers, source of truth should define values
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: vpe-id
+ in: query
+ description: Unique ID of VPE connected to this VCE.
+ required: false
+ type: string
+ - name: port-group-id
+ in: query
+ description: Unique ID for port group in vmware
+ required: false
+ type: string
+ - name: switch-name
+ in: query
+ description: DVS or standard switch name (should be non-null for port groups associated with DVS)
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing port-group
+ description: |
+ Create or update an existing port-group.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroup
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-id
+ in: path
+ description: Unique ID of the interface
+ required: true
+ type: string
+ example: __INTERFACE-ID__
+ - name: body
+ in: body
+ description: port-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVcePortGroupsPortGroup.json)
+ required: true
+ schema:
+ $ref: "#/definitions/port-group"
+ patch:
+ tags:
+ - Network
+ summary: update an existing port-group
+ description: |
+ Update an existing port-group
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkVcesVcePortGroupsPortGroup
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-id
+ in: path
+ description: Unique ID of the interface
+ required: true
+ type: string
+ example: __INTERFACE-ID__
+ - name: body
+ in: body
+ description: port-group object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/port-group"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing port-group
+ description: delete an existing port-group
+ operationId: deleteNetworkVcesVcePortGroupsPortGroup
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-id
+ in: path
+ description: Unique ID of the interface
+ required: true
+ type: string
+ example: __INTERFACE-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/vces/vce/{vnf-id}/port-groups:
+ get:
+ tags:
+ - Network
+ summary: returns port-groups
+ description: returns port-groups
+ operationId: getNetworkVcesVcePortGroups
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/port-groups"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
+ required: false
+ type: string
+ - name: regional-resource-zone
+ in: query
+ description: Regional way of organizing pservers, source of truth should define values
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: vpe-id
+ in: query
+ description: Unique ID of VPE connected to this VCE.
+ required: false
+ type: string
+ /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVcesVceLicensesLicenseRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: group-uuid
+ in: path
+ description: Unique ID for the license group the resource belongs to, should be uuid.
+ required: true
+ type: string
+ example: __GROUP-UUID__
+ - name: resource-uuid
+ in: path
+ description: Unique ID of a license resource.
+ required: true
+ type: string
+ example: __RESOURCE-UUID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVceLicensesLicense.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkVcesVceLicensesLicenseRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: group-uuid
+ in: path
+ description: Unique ID for the license group the resource belongs to, should be uuid.
+ required: true
+ type: string
+ example: __GROUP-UUID__
+ - name: resource-uuid
+ in: path
+ description: Unique ID of a license resource.
+ required: true
+ type: string
+ example: __RESOURCE-UUID__
+ /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}:
+ get:
+ tags:
+ - Network
+ summary: returns license
+ description: returns license
+ operationId: getNetworkVcesVceLicensesLicense
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/license"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: group-uuid
+ in: path
+ description: Unique ID for the license group the resource belongs to, should be uuid.
+ required: true
+ type: string
+ example: __GROUP-UUID__
+ - name: resource-uuid
+ in: path
+ description: Unique ID of a license resource.
+ required: true
+ type: string
+ example: __RESOURCE-UUID__
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
+ required: false
+ type: string
+ - name: regional-resource-zone
+ in: query
+ description: Regional way of organizing pservers, source of truth should define values
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: vpe-id
+ in: query
+ description: Unique ID of VPE connected to this VCE.
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing license
+ description: |
+ Create or update an existing license.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkVcesVceLicensesLicense
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: group-uuid
+ in: path
+ description: Unique ID for the license group the resource belongs to, should be uuid.
+ required: true
+ type: string
+ example: __GROUP-UUID__
+ - name: resource-uuid
+ in: path
+ description: Unique ID of a license resource.
+ required: true
+ type: string
+ example: __RESOURCE-UUID__
+ - name: body
+ in: body
+ description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVceLicensesLicense.json)
+ required: true
+ schema:
+ $ref: "#/definitions/license"
+ patch:
+ tags:
+ - Network
+ summary: update an existing license
+ description: |
+ Update an existing license
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkVcesVceLicensesLicense
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: group-uuid
+ in: path
+ description: Unique ID for the license group the resource belongs to, should be uuid.
+ required: true
+ type: string
+ example: __GROUP-UUID__
+ - name: resource-uuid
+ in: path
+ description: Unique ID of a license resource.
+ required: true
+ type: string
+ example: __RESOURCE-UUID__
+ - name: body
+ in: body
+ description: license object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/license"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing license
+ description: delete an existing license
+ operationId: deleteNetworkVcesVceLicensesLicense
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: group-uuid
+ in: path
+ description: Unique ID for the license group the resource belongs to, should be uuid.
+ required: true
+ type: string
+ example: __GROUP-UUID__
+ - name: resource-uuid
+ in: path
+ description: Unique ID of a license resource.
+ required: true
+ type: string
+ example: __RESOURCE-UUID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/vces/vce/{vnf-id}/licenses:
+ get:
+ tags:
+ - Network
+ summary: returns licenses
+ description: returns licenses
+ operationId: getNetworkVcesVceLicenses
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/licenses"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
+ required: false
+ type: string
+ - name: regional-resource-zone
+ in: query
+ description: Regional way of organizing pservers, source of truth should define values
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: vpe-id
+ in: query
+ description: Unique ID of VPE connected to this VCE.
+ required: false
+ type: string
+ /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: group-uuid
+ in: path
+ description: Unique ID for the entitlement group the resource comes from, should be uuid.
+ required: true
+ type: string
+ example: __GROUP-UUID__
+ - name: resource-uuid
+ in: path
+ description: Unique ID of an entitlement resource.
+ required: true
+ type: string
+ example: __RESOURCE-UUID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVceEntitlementsEntitlement.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: group-uuid
+ in: path
+ description: Unique ID for the entitlement group the resource comes from, should be uuid.
+ required: true
+ type: string
+ example: __GROUP-UUID__
+ - name: resource-uuid
+ in: path
+ description: Unique ID of an entitlement resource.
+ required: true
+ type: string
+ example: __RESOURCE-UUID__
+ /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}:
+ get:
+ tags:
+ - Network
+ summary: returns entitlement
+ description: returns entitlement
+ operationId: getNetworkVcesVceEntitlementsEntitlement
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/entitlement"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: group-uuid
+ in: path
+ description: Unique ID for the entitlement group the resource comes from, should be uuid.
+ required: true
+ type: string
+ example: __GROUP-UUID__
+ - name: resource-uuid
+ in: path
+ description: Unique ID of an entitlement resource.
+ required: true
+ type: string
+ example: __RESOURCE-UUID__
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
+ required: false
+ type: string
+ - name: regional-resource-zone
+ in: query
+ description: Regional way of organizing pservers, source of truth should define values
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: vpe-id
+ in: query
+ description: Unique ID of VPE connected to this VCE.
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing entitlement
+ description: |
+ Create or update an existing entitlement.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlement
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: group-uuid
+ in: path
+ description: Unique ID for the entitlement group the resource comes from, should be uuid.
+ required: true
+ type: string
+ example: __GROUP-UUID__
+ - name: resource-uuid
+ in: path
+ description: Unique ID of an entitlement resource.
+ required: true
+ type: string
+ example: __RESOURCE-UUID__
+ - name: body
+ in: body
+ description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVceEntitlementsEntitlement.json)
+ required: true
+ schema:
+ $ref: "#/definitions/entitlement"
+ patch:
+ tags:
+ - Network
+ summary: update an existing entitlement
+ description: |
+ Update an existing entitlement
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkVcesVceEntitlementsEntitlement
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: group-uuid
+ in: path
+ description: Unique ID for the entitlement group the resource comes from, should be uuid.
+ required: true
+ type: string
+ example: __GROUP-UUID__
+ - name: resource-uuid
+ in: path
+ description: Unique ID of an entitlement resource.
+ required: true
+ type: string
+ example: __RESOURCE-UUID__
+ - name: body
+ in: body
+ description: entitlement object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/entitlement"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing entitlement
+ description: delete an existing entitlement
+ operationId: deleteNetworkVcesVceEntitlementsEntitlement
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: group-uuid
+ in: path
+ description: Unique ID for the entitlement group the resource comes from, should be uuid.
+ required: true
+ type: string
+ example: __GROUP-UUID__
+ - name: resource-uuid
+ in: path
+ description: Unique ID of an entitlement resource.
+ required: true
+ type: string
+ example: __RESOURCE-UUID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/vces/vce/{vnf-id}/entitlements:
+ get:
+ tags:
+ - Network
+ summary: returns entitlements
+ description: returns entitlements
+ operationId: getNetworkVcesVceEntitlements
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/entitlements"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
+ required: false
+ type: string
+ - name: regional-resource-zone
+ in: query
+ description: Regional way of organizing pservers, source of truth should define values
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: vpe-id
+ in: query
+ description: Unique ID of VPE connected to this VCE.
+ required: false
+ type: string
+ /network/vces/vce/{vnf-id}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVcesVceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVce.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkVcesVceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ /network/vces/vce/{vnf-id}:
+ get:
+ tags:
+ - Network
+ summary: returns vce
+ description: returns vce
+ operationId: getNetworkVcesVce
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/vce"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
+ required: false
+ type: string
+ - name: regional-resource-zone
+ in: query
+ description: Regional way of organizing pservers, source of truth should define values
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: vpe-id
+ in: query
+ description: Unique ID of VPE connected to this VCE.
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing vce
+ description: |
+ Create or update an existing vce.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkVcesVce
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: body
+ in: body
+ description: vce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVce.json)
+ required: true
+ schema:
+ $ref: "#/definitions/vce"
+ patch:
+ tags:
+ - Network
+ summary: update an existing vce
+ description: |
+ Update an existing vce
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkVcesVce
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: body
+ in: body
+ description: vce object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/vce"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing vce
+ description: delete an existing vce
+ operationId: deleteNetworkVcesVce
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/vces:
+ get:
+ tags:
+ - Network
+ summary: returns vces
+ description: returns vces
+ operationId: getNetworkVces
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/vces"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVnfcsVnfcRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnfc-name
+ in: path
+ description: Unique ID of vnfc.
+ required: true
+ type: string
+ example: __VNFC-NAME__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVnfcsVnfc.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkVnfcsVnfcRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnfc-name
+ in: path
+ description: Unique ID of vnfc.
+ required: true
+ type: string
+ example: __VNFC-NAME__
+ /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnfc-name
+ in: path
+ description: Unique ID of vnfc.
+ required: true
+ type: string
+ example: __VNFC-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVnfcsVnfcL3InterfaceIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnfc-name
+ in: path
+ description: Unique ID of vnfc.
+ required: true
+ type: string
+ example: __VNFC-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
+ get:
+ tags:
+ - Network
+ summary: returns l3-interface-ipv4-address-list
+ description: returns l3-interface-ipv4-address-list
+ operationId: getNetworkVnfcsVnfcL3InterfaceIpv4AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnfc-name
+ in: path
+ description: Unique ID of vnfc.
+ required: true
+ type: string
+ example: __VNFC-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: nfc-naming-code
+ in: query
+ description: Short code that is used in naming instances of the item being modeled
+ required: false
+ type: string
+ - name: nfc-function
+ in: query
+ description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: prov status of this vnfc
+ required: false
+ type: string
+ - name: ipaddress-v4-oam-vip
+ in: query
+ description: Oam V4 vip address of this vnfc
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ required: false
+ type: boolean
+ - name: group-notation
+ in: query
+ description: Group notation of VNFC
+ required: false
+ type: string
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface that address belongs to
+ required: false
+ type: string
+ - name: neutron-subnet-id
+ in: query
+ description: Neutron id of subnet that address belongs to
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing l3-interface-ipv4-address-list
+ description: |
+ Create or update an existing l3-interface-ipv4-address-list.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnfc-name
+ in: path
+ description: Unique ID of vnfc.
+ required: true
+ type: string
+ example: __VNFC-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVnfcsVnfcL3InterfaceIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv4-address-list"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l3-interface-ipv4-address-list
+ description: |
+ Update an existing l3-interface-ipv4-address-list
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnfc-name
+ in: path
+ description: Unique ID of vnfc.
+ required: true
+ type: string
+ example: __VNFC-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing l3-interface-ipv4-address-list
+ description: delete an existing l3-interface-ipv4-address-list
+ operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnfc-name
+ in: path
+ description: Unique ID of vnfc.
+ required: true
+ type: string
+ example: __VNFC-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnfc-name
+ in: path
+ description: Unique ID of vnfc.
+ required: true
+ type: string
+ example: __VNFC-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVnfcsVnfcL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnfc-name
+ in: path
+ description: Unique ID of vnfc.
+ required: true
+ type: string
+ example: __VNFC-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
+ get:
+ tags:
+ - Network
+ summary: returns l3-interface-ipv6-address-list
+ description: returns l3-interface-ipv6-address-list
+ operationId: getNetworkVnfcsVnfcL3InterfaceIpv6AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnfc-name
+ in: path
+ description: Unique ID of vnfc.
+ required: true
+ type: string
+ example: __VNFC-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: nfc-naming-code
+ in: query
+ description: Short code that is used in naming instances of the item being modeled
+ required: false
+ type: string
+ - name: nfc-function
+ in: query
+ description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: prov status of this vnfc
+ required: false
+ type: string
+ - name: ipaddress-v4-oam-vip
+ in: query
+ description: Oam V4 vip address of this vnfc
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ required: false
+ type: boolean
+ - name: group-notation
+ in: query
+ description: Group notation of VNFC
+ required: false
+ type: string
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface that address belongs to
+ required: false
+ type: string
+ - name: neutron-subnet-id
+ in: query
+ description: Neutron id of subnet that address belongs to
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing l3-interface-ipv6-address-list
+ description: |
+ Create or update an existing l3-interface-ipv6-address-list.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnfc-name
+ in: path
+ description: Unique ID of vnfc.
+ required: true
+ type: string
+ example: __VNFC-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVnfcsVnfcL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l3-interface-ipv6-address-list
+ description: |
+ Update an existing l3-interface-ipv6-address-list
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnfc-name
+ in: path
+ description: Unique ID of vnfc.
+ required: true
+ type: string
+ example: __VNFC-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing l3-interface-ipv6-address-list
+ description: delete an existing l3-interface-ipv6-address-list
+ operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnfc-name
+ in: path
+ description: Unique ID of vnfc.
+ required: true
+ type: string
+ example: __VNFC-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/vnfcs/vnfc/{vnfc-name}:
+ get:
+ tags:
+ - Network
+ summary: returns vnfc
+ description: returns vnfc
+ operationId: getNetworkVnfcsVnfc
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/vnfc"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnfc-name
+ in: path
+ description: Unique ID of vnfc.
+ required: true
+ type: string
+ example: __VNFC-NAME__
+ - name: nfc-naming-code
+ in: query
+ description: Short code that is used in naming instances of the item being modeled
+ required: false
+ type: string
+ - name: nfc-function
+ in: query
+ description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: prov status of this vnfc
+ required: false
+ type: string
+ - name: ipaddress-v4-oam-vip
+ in: query
+ description: Oam V4 vip address of this vnfc
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ required: false
+ type: boolean
+ - name: group-notation
+ in: query
+ description: Group notation of VNFC
+ required: false
+ type: string
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing vnfc
+ description: |
+ Create or update an existing vnfc.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkVnfcsVnfc
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnfc-name
+ in: path
+ description: Unique ID of vnfc.
+ required: true
+ type: string
+ example: __VNFC-NAME__
+ - name: body
+ in: body
+ description: vnfc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVnfcsVnfc.json)
+ required: true
+ schema:
+ $ref: "#/definitions/vnfc"
+ patch:
+ tags:
+ - Network
+ summary: update an existing vnfc
+ description: |
+ Update an existing vnfc
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkVnfcsVnfc
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnfc-name
+ in: path
+ description: Unique ID of vnfc.
+ required: true
+ type: string
+ example: __VNFC-NAME__
+ - name: body
+ in: body
+ description: vnfc object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/vnfc"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing vnfc
+ description: delete an existing vnfc
+ operationId: deleteNetworkVnfcsVnfc
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnfc-name
+ in: path
+ description: Unique ID of vnfc.
+ required: true
+ type: string
+ example: __VNFC-NAME__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/vnfcs:
+ get:
+ tags:
+ - Network
+ summary: returns vnfcs
+ description: returns vnfcs
+ operationId: getNetworkVnfcs
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/vnfcs"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRouteRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-id
+ in: path
+ description: Network ID, should be uuid. Unique across A&AI.
+ required: true
+ type: string
+ example: __NETWORK-ID__
+ - name: subnet-id
+ in: path
+ description: Subnet ID, should be UUID.
+ required: true
+ type: string
+ example: __SUBNET-ID__
+ - name: host-route-id
+ in: path
+ description: host-route id
+ required: true
+ type: string
+ example: __HOST-ROUTE-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRouteRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-id
+ in: path
+ description: Network ID, should be uuid. Unique across A&AI.
+ required: true
+ type: string
+ example: __NETWORK-ID__
+ - name: subnet-id
+ in: path
+ description: Subnet ID, should be UUID.
+ required: true
+ type: string
+ example: __SUBNET-ID__
+ - name: host-route-id
+ in: path
+ description: host-route id
+ required: true
+ type: string
+ example: __HOST-ROUTE-ID__
+ /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}:
+ get:
+ tags:
+ - Network
+ summary: returns host-route
+ description: returns host-route
+ operationId: getNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/host-route"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-id
+ in: path
+ description: Network ID, should be uuid. Unique across A&AI.
+ required: true
+ type: string
+ example: __NETWORK-ID__
+ - name: subnet-id
+ in: path
+ description: Subnet ID, should be UUID.
+ required: true
+ type: string
+ example: __SUBNET-ID__
+ - name: host-route-id
+ in: path
+ description: host-route id
+ required: true
+ type: string
+ example: __HOST-ROUTE-ID__
+ - name: network-name
+ in: query
+ description: Name of the network, governed by some naming convention..
+ required: false
+ type: string
+ - name: network-role
+ in: query
+ description: Role the network plans - who defines these values?
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: contrail-network-fqdn
+ in: query
+ description: Contrail FQDN for the network
+ required: false
+ type: string
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ - name: subnet-name
+ in: query
+ description: Name associated with the subnet.
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing host-route
+ description: |
+ Create or update an existing host-route.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-id
+ in: path
+ description: Network ID, should be uuid. Unique across A&AI.
+ required: true
+ type: string
+ example: __NETWORK-ID__
+ - name: subnet-id
+ in: path
+ description: Subnet ID, should be UUID.
+ required: true
+ type: string
+ example: __SUBNET-ID__
+ - name: host-route-id
+ in: path
+ description: host-route id
+ required: true
+ type: string
+ example: __HOST-ROUTE-ID__
+ - name: body
+ in: body
+ description: host-route object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.json)
+ required: true
+ schema:
+ $ref: "#/definitions/host-route"
+ patch:
+ tags:
+ - Network
+ summary: update an existing host-route
+ description: |
+ Update an existing host-route
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-id
+ in: path
+ description: Network ID, should be uuid. Unique across A&AI.
+ required: true
+ type: string
+ example: __NETWORK-ID__
+ - name: subnet-id
+ in: path
+ description: Subnet ID, should be UUID.
+ required: true
+ type: string
+ example: __SUBNET-ID__
+ - name: host-route-id
+ in: path
+ description: host-route id
+ required: true
+ type: string
+ example: __HOST-ROUTE-ID__
+ - name: body
+ in: body
+ description: host-route object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/host-route"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing host-route
+ description: delete an existing host-route
+ operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-id
+ in: path
+ description: Network ID, should be uuid. Unique across A&AI.
+ required: true
+ type: string
+ example: __NETWORK-ID__
+ - name: subnet-id
+ in: path
+ description: Subnet ID, should be UUID.
+ required: true
+ type: string
+ example: __SUBNET-ID__
+ - name: host-route-id
+ in: path
+ description: host-route id
+ required: true
+ type: string
+ example: __HOST-ROUTE-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes:
+ get:
+ tags:
+ - Network
+ summary: returns host-routes
+ description: returns host-routes
+ operationId: getNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutes
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/host-routes"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-id
+ in: path
+ description: Network ID, should be uuid. Unique across A&AI.
+ required: true
+ type: string
+ example: __NETWORK-ID__
+ - name: subnet-id
+ in: path
+ description: Subnet ID, should be UUID.
+ required: true
+ type: string
+ example: __SUBNET-ID__
+ - name: network-name
+ in: query
+ description: Name of the network, governed by some naming convention..
+ required: false
+ type: string
+ - name: network-role
+ in: query
+ description: Role the network plans - who defines these values?
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: contrail-network-fqdn
+ in: query
+ description: Contrail FQDN for the network
+ required: false
+ type: string
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ - name: subnet-name
+ in: query
+ description: Name associated with the subnet.
+ required: false
+ type: string
+ /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-id
+ in: path
+ description: Network ID, should be uuid. Unique across A&AI.
+ required: true
+ type: string
+ example: __NETWORK-ID__
+ - name: subnet-id
+ in: path
+ description: Subnet ID, should be UUID.
+ required: true
+ type: string
+ example: __SUBNET-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkSubnetsSubnet.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-id
+ in: path
+ description: Network ID, should be uuid. Unique across A&AI.
+ required: true
+ type: string
+ example: __NETWORK-ID__
+ - name: subnet-id
+ in: path
+ description: Subnet ID, should be UUID.
+ required: true
+ type: string
+ example: __SUBNET-ID__
+ /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}:
+ get:
+ tags:
+ - Network
+ summary: returns subnet
+ description: returns subnet
+ operationId: getNetworkL3NetworksL3NetworkSubnetsSubnet
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/subnet"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-id
+ in: path
+ description: Network ID, should be uuid. Unique across A&AI.
+ required: true
+ type: string
+ example: __NETWORK-ID__
+ - name: subnet-id
+ in: path
+ description: Subnet ID, should be UUID.
+ required: true
+ type: string
+ example: __SUBNET-ID__
+ - name: network-name
+ in: query
+ description: Name of the network, governed by some naming convention..
+ required: false
+ type: string
+ - name: network-role
+ in: query
+ description: Role the network plans - who defines these values?
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: contrail-network-fqdn
+ in: query
+ description: Contrail FQDN for the network
+ required: false
+ type: string
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ - name: subnet-name
+ in: query
+ description: Name associated with the subnet.
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing subnet
+ description: |
+ Create or update an existing subnet.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnet
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-id
+ in: path
+ description: Network ID, should be uuid. Unique across A&AI.
+ required: true
+ type: string
+ example: __NETWORK-ID__
+ - name: subnet-id
+ in: path
+ description: Subnet ID, should be UUID.
+ required: true
+ type: string
+ example: __SUBNET-ID__
+ - name: body
+ in: body
+ description: subnet object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkSubnetsSubnet.json)
+ required: true
+ schema:
+ $ref: "#/definitions/subnet"
+ patch:
+ tags:
+ - Network
+ summary: update an existing subnet
+ description: |
+ Update an existing subnet
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkL3NetworksL3NetworkSubnetsSubnet
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-id
+ in: path
+ description: Network ID, should be uuid. Unique across A&AI.
+ required: true
+ type: string
+ example: __NETWORK-ID__
+ - name: subnet-id
+ in: path
+ description: Subnet ID, should be UUID.
+ required: true
+ type: string
+ example: __SUBNET-ID__
+ - name: body
+ in: body
+ description: subnet object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/subnet"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing subnet
+ description: delete an existing subnet
+ operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnet
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-id
+ in: path
+ description: Network ID, should be uuid. Unique across A&AI.
+ required: true
+ type: string
+ example: __NETWORK-ID__
+ - name: subnet-id
+ in: path
+ description: Subnet ID, should be UUID.
+ required: true
+ type: string
+ example: __SUBNET-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/l3-networks/l3-network/{network-id}/subnets:
+ get:
+ tags:
+ - Network
+ summary: returns subnets
+ description: returns subnets
+ operationId: getNetworkL3NetworksL3NetworkSubnets
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/subnets"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-id
+ in: path
+ description: Network ID, should be uuid. Unique across A&AI.
+ required: true
+ type: string
+ example: __NETWORK-ID__
+ - name: network-name
+ in: query
+ description: Name of the network, governed by some naming convention..
+ required: false
+ type: string
+ - name: network-role
+ in: query
+ description: Role the network plans - who defines these values?
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: contrail-network-fqdn
+ in: query
+ description: Contrail FQDN for the network
+ required: false
+ type: string
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-id
+ in: path
+ description: Network ID, should be uuid. Unique across A&AI.
+ required: true
+ type: string
+ example: __NETWORK-ID__
+ - name: vlan-id-inner
+ in: path
+ description: id.
+ required: true
+ type: integer
+ format: int64
+ example: __VLAN-ID-INNER__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-id
+ in: path
+ description: Network ID, should be uuid. Unique across A&AI.
+ required: true
+ type: string
+ example: __NETWORK-ID__
+ - name: vlan-id-inner
+ in: path
+ description: id.
+ required: true
+ type: integer
+ format: int64
+ example: __VLAN-ID-INNER__
+ /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}:
+ get:
+ tags:
+ - Network
+ summary: returns ctag-assignment
+ description: returns ctag-assignment
+ operationId: getNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/ctag-assignment"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-id
+ in: path
+ description: Network ID, should be uuid. Unique across A&AI.
+ required: true
+ type: string
+ example: __NETWORK-ID__
+ - name: vlan-id-inner
+ in: path
+ description: id.
+ required: true
+ type: integer
+ format: int64
+ example: __VLAN-ID-INNER__
+ - name: network-name
+ in: query
+ description: Name of the network, governed by some naming convention..
+ required: false
+ type: string
+ - name: network-role
+ in: query
+ description: Role the network plans - who defines these values?
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: contrail-network-fqdn
+ in: query
+ description: Contrail FQDN for the network
+ required: false
+ type: string
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing ctag-assignment
+ description: |
+ Create or update an existing ctag-assignment.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-id
+ in: path
+ description: Network ID, should be uuid. Unique across A&AI.
+ required: true
+ type: string
+ example: __NETWORK-ID__
+ - name: vlan-id-inner
+ in: path
+ description: id.
+ required: true
+ type: integer
+ format: int64
+ example: __VLAN-ID-INNER__
+ - name: body
+ in: body
+ description: ctag-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)
+ required: true
+ schema:
+ $ref: "#/definitions/ctag-assignment"
+ patch:
+ tags:
+ - Network
+ summary: update an existing ctag-assignment
+ description: |
+ Update an existing ctag-assignment
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-id
+ in: path
+ description: Network ID, should be uuid. Unique across A&AI.
+ required: true
+ type: string
+ example: __NETWORK-ID__
+ - name: vlan-id-inner
+ in: path
+ description: id.
+ required: true
+ type: integer
+ format: int64
+ example: __VLAN-ID-INNER__
+ - name: body
+ in: body
+ description: ctag-assignment object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/ctag-assignment"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing ctag-assignment
+ description: delete an existing ctag-assignment
+ operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-id
+ in: path
+ description: Network ID, should be uuid. Unique across A&AI.
+ required: true
+ type: string
+ example: __NETWORK-ID__
+ - name: vlan-id-inner
+ in: path
+ description: id.
+ required: true
+ type: integer
+ format: int64
+ example: __VLAN-ID-INNER__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/l3-networks/l3-network/{network-id}/ctag-assignments:
+ get:
+ tags:
+ - Network
+ summary: returns ctag-assignments
+ description: returns ctag-assignments
+ operationId: getNetworkL3NetworksL3NetworkCtagAssignments
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/ctag-assignments"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-id
+ in: path
+ description: Network ID, should be uuid. Unique across A&AI.
+ required: true
+ type: string
+ example: __NETWORK-ID__
+ - name: network-name
+ in: query
+ description: Name of the network, governed by some naming convention..
+ required: false
+ type: string
+ - name: network-role
+ in: query
+ description: Role the network plans - who defines these values?
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: contrail-network-fqdn
+ in: query
+ description: Contrail FQDN for the network
+ required: false
+ type: string
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-id
+ in: path
+ description: Network ID, should be uuid. Unique across A&AI.
+ required: true
+ type: string
+ example: __NETWORK-ID__
+ - name: segmentation-id
+ in: path
+ description: Route Table Reference id, UUID assigned to this instance.
+ required: true
+ type: string
+ example: __SEGMENTATION-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-id
+ in: path
+ description: Network ID, should be uuid. Unique across A&AI.
+ required: true
+ type: string
+ example: __NETWORK-ID__
+ - name: segmentation-id
+ in: path
+ description: Route Table Reference id, UUID assigned to this instance.
+ required: true
+ type: string
+ example: __SEGMENTATION-ID__
+ /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}:
+ get:
+ tags:
+ - Network
+ summary: returns segmentation-assignment
+ description: returns segmentation-assignment
+ operationId: getNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/segmentation-assignment"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-id
+ in: path
+ description: Network ID, should be uuid. Unique across A&AI.
+ required: true
+ type: string
+ example: __NETWORK-ID__
+ - name: segmentation-id
+ in: path
+ description: Route Table Reference id, UUID assigned to this instance.
+ required: true
+ type: string
+ example: __SEGMENTATION-ID__
+ - name: network-name
+ in: query
+ description: Name of the network, governed by some naming convention..
+ required: false
+ type: string
+ - name: network-role
+ in: query
+ description: Role the network plans - who defines these values?
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: contrail-network-fqdn
+ in: query
+ description: Contrail FQDN for the network
+ required: false
+ type: string
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing segmentation-assignment
+ description: |
+ Create or update an existing segmentation-assignment.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-id
+ in: path
+ description: Network ID, should be uuid. Unique across A&AI.
+ required: true
+ type: string
+ example: __NETWORK-ID__
+ - name: segmentation-id
+ in: path
+ description: Route Table Reference id, UUID assigned to this instance.
+ required: true
+ type: string
+ example: __SEGMENTATION-ID__
+ - name: body
+ in: body
+ description: segmentation-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)
+ required: true
+ schema:
+ $ref: "#/definitions/segmentation-assignment"
+ patch:
+ tags:
+ - Network
+ summary: update an existing segmentation-assignment
+ description: |
+ Update an existing segmentation-assignment
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-id
+ in: path
+ description: Network ID, should be uuid. Unique across A&AI.
+ required: true
+ type: string
+ example: __NETWORK-ID__
+ - name: segmentation-id
+ in: path
+ description: Route Table Reference id, UUID assigned to this instance.
+ required: true
+ type: string
+ example: __SEGMENTATION-ID__
+ - name: body
+ in: body
+ description: segmentation-assignment object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/segmentation-assignment"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing segmentation-assignment
+ description: delete an existing segmentation-assignment
+ operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-id
+ in: path
+ description: Network ID, should be uuid. Unique across A&AI.
+ required: true
+ type: string
+ example: __NETWORK-ID__
+ - name: segmentation-id
+ in: path
+ description: Route Table Reference id, UUID assigned to this instance.
+ required: true
+ type: string
+ example: __SEGMENTATION-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/l3-networks/l3-network/{network-id}/segmentation-assignments:
+ get:
+ tags:
+ - Network
+ summary: returns segmentation-assignments
+ description: returns segmentation-assignments
+ operationId: getNetworkL3NetworksL3NetworkSegmentationAssignments
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/segmentation-assignments"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-id
+ in: path
+ description: Network ID, should be uuid. Unique across A&AI.
+ required: true
+ type: string
+ example: __NETWORK-ID__
+ - name: network-name
+ in: query
+ description: Name of the network, governed by some naming convention..
+ required: false
+ type: string
+ - name: network-role
+ in: query
+ description: Role the network plans - who defines these values?
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: contrail-network-fqdn
+ in: query
+ description: Contrail FQDN for the network
+ required: false
+ type: string
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ /network/l3-networks/l3-network/{network-id}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkL3NetworksL3NetworkRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-id
+ in: path
+ description: Network ID, should be uuid. Unique across A&AI.
+ required: true
+ type: string
+ example: __NETWORK-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3Network.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkL3NetworksL3NetworkRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-id
+ in: path
+ description: Network ID, should be uuid. Unique across A&AI.
+ required: true
+ type: string
+ example: __NETWORK-ID__
+ /network/l3-networks/l3-network/{network-id}:
+ get:
+ tags:
+ - Network
+ summary: returns l3-network
+ description: returns l3-network
+ operationId: getNetworkL3NetworksL3Network
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l3-network"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-id
+ in: path
+ description: Network ID, should be uuid. Unique across A&AI.
+ required: true
+ type: string
+ example: __NETWORK-ID__
+ - name: network-name
+ in: query
+ description: Name of the network, governed by some naming convention..
+ required: false
+ type: string
+ - name: network-role
+ in: query
+ description: Role the network plans - who defines these values?
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: contrail-network-fqdn
+ in: query
+ description: Contrail FQDN for the network
+ required: false
+ type: string
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing l3-network
+ description: |
+ Create or update an existing l3-network.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkL3NetworksL3Network
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-id
+ in: path
+ description: Network ID, should be uuid. Unique across A&AI.
+ required: true
+ type: string
+ example: __NETWORK-ID__
+ - name: body
+ in: body
+ description: l3-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3Network.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-network"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l3-network
+ description: |
+ Update an existing l3-network
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkL3NetworksL3Network
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-id
+ in: path
+ description: Network ID, should be uuid. Unique across A&AI.
+ required: true
+ type: string
+ example: __NETWORK-ID__
+ - name: body
+ in: body
+ description: l3-network object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-network"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing l3-network
+ description: delete an existing l3-network
+ operationId: deleteNetworkL3NetworksL3Network
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-id
+ in: path
+ description: Network ID, should be uuid. Unique across A&AI.
+ required: true
+ type: string
+ example: __NETWORK-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/l3-networks:
+ get:
+ tags:
+ - Network
+ summary: returns l3-networks
+ description: returns l3-networks
+ operationId: getNetworkL3Networks
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l3-networks"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-policy-id
+ in: path
+ description: UUID representing unique key to this instance
+ required: true
+ type: string
+ example: __NETWORK-POLICY-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNetworkPoliciesNetworkPolicy.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-policy-id
+ in: path
+ description: UUID representing unique key to this instance
+ required: true
+ type: string
+ example: __NETWORK-POLICY-ID__
+ /network/network-policies/network-policy/{network-policy-id}:
+ get:
+ tags:
+ - Network
+ summary: returns network-policy
+ description: returns network-policy
+ operationId: getNetworkNetworkPoliciesNetworkPolicy
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/network-policy"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-policy-id
+ in: path
+ description: UUID representing unique key to this instance
+ required: true
+ type: string
+ example: __NETWORK-POLICY-ID__
+ - name: network-policy-fqdn
+ in: query
+ description: Contrail FQDN for the policy
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing network-policy
+ description: |
+ Create or update an existing network-policy.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicy
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-policy-id
+ in: path
+ description: UUID representing unique key to this instance
+ required: true
+ type: string
+ example: __NETWORK-POLICY-ID__
+ - name: body
+ in: body
+ description: network-policy object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNetworkPoliciesNetworkPolicy.json)
+ required: true
+ schema:
+ $ref: "#/definitions/network-policy"
+ patch:
+ tags:
+ - Network
+ summary: update an existing network-policy
+ description: |
+ Update an existing network-policy
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkNetworkPoliciesNetworkPolicy
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-policy-id
+ in: path
+ description: UUID representing unique key to this instance
+ required: true
+ type: string
+ example: __NETWORK-POLICY-ID__
+ - name: body
+ in: body
+ description: network-policy object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/network-policy"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing network-policy
+ description: delete an existing network-policy
+ operationId: deleteNetworkNetworkPoliciesNetworkPolicy
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-policy-id
+ in: path
+ description: UUID representing unique key to this instance
+ required: true
+ type: string
+ example: __NETWORK-POLICY-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/network-policies:
+ get:
+ tags:
+ - Network
+ summary: returns network-policies
+ description: returns network-policies
+ operationId: getNetworkNetworkPolicies
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/network-policies"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkGenericVnfsGenericVnfRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnf.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkGenericVnfsGenericVnfRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ /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:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ /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:
+ tags:
+ - Network
+ summary: returns l3-interface-ipv4-address-list
+ description: returns l3-interface-ipv4-address-list
+ operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
+ required: false
+ type: string
+ - name: regional-resource-zone
+ in: query
+ description: Regional way of organizing pservers, source of truth should define values
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ required: false
+ type: boolean
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ - name: nf-type
+ in: query
+ description: Generic description of the type of NF
+ required: false
+ type: string
+ - name: nf-function
+ in: query
+ description: English description of Network function that the specific VNF deployment is providing
+ required: false
+ type: string
+ - name: nf-role
+ in: query
+ description: role in the network that this model will be providing
+ required: false
+ type: string
+ - name: nf-naming-code
+ in: query
+ description: string assigned to this model used for naming purposes
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: vpn-key
+ in: query
+ description: This indicates the customers VPN ID associated with this vlan
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface that address belongs to
+ required: false
+ type: string
+ - name: neutron-subnet-id
+ in: query
+ description: Neutron id of subnet that address belongs to
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing l3-interface-ipv4-address-list
+ description: |
+ Create or update an existing l3-interface-ipv4-address-list.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv4-address-list"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l3-interface-ipv4-address-list
+ description: |
+ Update an existing l3-interface-ipv4-address-list
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing l3-interface-ipv4-address-list
+ description: delete an existing l3-interface-ipv4-address-list
+ operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /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:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ /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:
+ tags:
+ - Network
+ summary: returns l3-interface-ipv6-address-list
+ description: returns l3-interface-ipv6-address-list
+ operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
+ required: false
+ type: string
+ - name: regional-resource-zone
+ in: query
+ description: Regional way of organizing pservers, source of truth should define values
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ required: false
+ type: boolean
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ - name: nf-type
+ in: query
+ description: Generic description of the type of NF
+ required: false
+ type: string
+ - name: nf-function
+ in: query
+ description: English description of Network function that the specific VNF deployment is providing
+ required: false
+ type: string
+ - name: nf-role
+ in: query
+ description: role in the network that this model will be providing
+ required: false
+ type: string
+ - name: nf-naming-code
+ in: query
+ description: string assigned to this model used for naming purposes
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: vpn-key
+ in: query
+ description: This indicates the customers VPN ID associated with this vlan
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface that address belongs to
+ required: false
+ type: string
+ - name: neutron-subnet-id
+ in: query
+ description: Neutron id of subnet that address belongs to
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing l3-interface-ipv6-address-list
+ description: |
+ Create or update an existing l3-interface-ipv6-address-list.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l3-interface-ipv6-address-list
+ description: |
+ Update an existing l3-interface-ipv6-address-list
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing l3-interface-ipv6-address-list
+ description: delete an existing l3-interface-ipv6-address-list
+ operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
+ get:
+ tags:
+ - Network
+ summary: returns vlan
+ description: returns vlan
+ operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/vlan"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
+ required: false
+ type: string
+ - name: regional-resource-zone
+ in: query
+ description: Regional way of organizing pservers, source of truth should define values
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ required: false
+ type: boolean
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ - name: nf-type
+ in: query
+ description: Generic description of the type of NF
+ required: false
+ type: string
+ - name: nf-function
+ in: query
+ description: English description of Network function that the specific VNF deployment is providing
+ required: false
+ type: string
+ - name: nf-role
+ in: query
+ description: role in the network that this model will be providing
+ required: false
+ type: string
+ - name: nf-naming-code
+ in: query
+ description: string assigned to this model used for naming purposes
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: vpn-key
+ in: query
+ description: This indicates the customers VPN ID associated with this vlan
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing vlan
+ description: |
+ Create or update an existing vlan.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: body
+ in: body
+ description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)
+ required: true
+ schema:
+ $ref: "#/definitions/vlan"
+ patch:
+ tags:
+ - Network
+ summary: update an existing vlan
+ description: |
+ Update an existing vlan
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: body
+ in: body
+ description: vlan object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/vlan"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing vlan
+ description: delete an existing vlan
+ operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans:
+ get:
+ tags:
+ - Network
+ summary: returns vlans
+ description: returns vlans
+ operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlans
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/vlans"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
+ required: false
+ type: string
+ - name: regional-resource-zone
+ in: query
+ description: Regional way of organizing pservers, source of truth should define values
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ required: false
+ type: boolean
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ - name: nf-type
+ in: query
+ description: Generic description of the type of NF
+ required: false
+ type: string
+ - name: nf-function
+ in: query
+ description: English description of Network function that the specific VNF deployment is providing
+ required: false
+ type: string
+ - name: nf-role
+ in: query
+ description: role in the network that this model will be providing
+ required: false
+ type: string
+ - name: nf-naming-code
+ in: query
+ description: string assigned to this model used for naming purposes
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
+ get:
+ tags:
+ - Network
+ summary: returns sriov-vf
+ description: returns sriov-vf
+ operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/sriov-vf"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
+ required: false
+ type: string
+ - name: regional-resource-zone
+ in: query
+ description: Regional way of organizing pservers, source of truth should define values
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ required: false
+ type: boolean
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ - name: nf-type
+ in: query
+ description: Generic description of the type of NF
+ required: false
+ type: string
+ - name: nf-function
+ in: query
+ description: English description of Network function that the specific VNF deployment is providing
+ required: false
+ type: string
+ - name: nf-role
+ in: query
+ description: role in the network that this model will be providing
+ required: false
+ type: string
+ - name: nf-naming-code
+ in: query
+ description: string assigned to this model used for naming purposes
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vf-vlan-filter
+ in: query
+ description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
+ required: false
+ type: string
+ - name: vf-mac-filter
+ in: query
+ description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
+ required: false
+ type: string
+ - name: vf-vlan-strip
+ in: query
+ description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
+ required: false
+ type: boolean
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing sriov-vf
+ description: |
+ Create or update an existing sriov-vf.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: body
+ in: body
+ description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)
+ required: true
+ schema:
+ $ref: "#/definitions/sriov-vf"
+ patch:
+ tags:
+ - Network
+ summary: update an existing sriov-vf
+ description: |
+ Update an existing sriov-vf
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: body
+ in: body
+ description: sriov-vf object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/sriov-vf"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing sriov-vf
+ description: delete an existing sriov-vf
+ operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
+ get:
+ tags:
+ - Network
+ summary: returns sriov-vfs
+ description: returns sriov-vfs
+ operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfs
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/sriov-vfs"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
+ required: false
+ type: string
+ - name: regional-resource-zone
+ in: query
+ description: Regional way of organizing pservers, source of truth should define values
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ required: false
+ type: boolean
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ - name: nf-type
+ in: query
+ description: Generic description of the type of NF
+ required: false
+ type: string
+ - name: nf-function
+ in: query
+ description: English description of Network function that the specific VNF deployment is providing
+ required: false
+ type: string
+ - name: nf-role
+ in: query
+ description: role in the network that this model will be providing
+ required: false
+ type: string
+ - name: nf-naming-code
+ in: query
+ description: string assigned to this model used for naming purposes
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ /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:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
+ get:
+ tags:
+ - Network
+ summary: returns l3-interface-ipv4-address-list
+ description: returns l3-interface-ipv4-address-list
+ operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
+ required: false
+ type: string
+ - name: regional-resource-zone
+ in: query
+ description: Regional way of organizing pservers, source of truth should define values
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ required: false
+ type: boolean
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ - name: nf-type
+ in: query
+ description: Generic description of the type of NF
+ required: false
+ type: string
+ - name: nf-function
+ in: query
+ description: English description of Network function that the specific VNF deployment is providing
+ required: false
+ type: string
+ - name: nf-role
+ in: query
+ description: role in the network that this model will be providing
+ required: false
+ type: string
+ - name: nf-naming-code
+ in: query
+ description: string assigned to this model used for naming purposes
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface that address belongs to
+ required: false
+ type: string
+ - name: neutron-subnet-id
+ in: query
+ description: Neutron id of subnet that address belongs to
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing l3-interface-ipv4-address-list
+ description: |
+ Create or update an existing l3-interface-ipv4-address-list.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv4-address-list"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l3-interface-ipv4-address-list
+ description: |
+ Update an existing l3-interface-ipv4-address-list
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing l3-interface-ipv4-address-list
+ description: delete an existing l3-interface-ipv4-address-list
+ operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /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:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
+ get:
+ tags:
+ - Network
+ summary: returns l3-interface-ipv6-address-list
+ description: returns l3-interface-ipv6-address-list
+ operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
+ required: false
+ type: string
+ - name: regional-resource-zone
+ in: query
+ description: Regional way of organizing pservers, source of truth should define values
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ required: false
+ type: boolean
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ - name: nf-type
+ in: query
+ description: Generic description of the type of NF
+ required: false
+ type: string
+ - name: nf-function
+ in: query
+ description: English description of Network function that the specific VNF deployment is providing
+ required: false
+ type: string
+ - name: nf-role
+ in: query
+ description: role in the network that this model will be providing
+ required: false
+ type: string
+ - name: nf-naming-code
+ in: query
+ description: string assigned to this model used for naming purposes
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface that address belongs to
+ required: false
+ type: string
+ - name: neutron-subnet-id
+ in: query
+ description: Neutron id of subnet that address belongs to
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing l3-interface-ipv6-address-list
+ description: |
+ Create or update an existing l3-interface-ipv6-address-list.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l3-interface-ipv6-address-list
+ description: |
+ Update an existing l3-interface-ipv6-address-list
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing l3-interface-ipv6-address-list
+ description: delete an existing l3-interface-ipv6-address-list
+ operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}:
+ get:
+ tags:
+ - Network
+ summary: returns l-interface
+ description: returns l-interface
+ operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterface
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l-interface"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
+ required: false
+ type: string
+ - name: regional-resource-zone
+ in: query
+ description: Regional way of organizing pservers, source of truth should define values
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ required: false
+ type: boolean
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ - name: nf-type
+ in: query
+ description: Generic description of the type of NF
+ required: false
+ type: string
+ - name: nf-function
+ in: query
+ description: English description of Network function that the specific VNF deployment is providing
+ required: false
+ type: string
+ - name: nf-role
+ in: query
+ description: role in the network that this model will be providing
+ required: false
+ type: string
+ - name: nf-naming-code
+ in: query
+ description: string assigned to this model used for naming purposes
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing l-interface
+ description: |
+ Create or update an existing l-interface.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l-interface"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l-interface
+ description: |
+ Update an existing l-interface
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: l-interface object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l-interface"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing l-interface
+ description: delete an existing l-interface
+ operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces:
+ get:
+ tags:
+ - Network
+ summary: returns l-interfaces
+ description: returns l-interfaces
+ operationId: getNetworkGenericVnfsGenericVnfLInterfaces
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l-interfaces"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
+ required: false
+ type: string
+ - name: regional-resource-zone
+ in: query
+ description: Regional way of organizing pservers, source of truth should define values
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ required: false
+ type: boolean
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ - name: nf-type
+ in: query
+ description: Generic description of the type of NF
+ required: false
+ type: string
+ - name: nf-function
+ in: query
+ description: English description of Network function that the specific VNF deployment is providing
+ required: false
+ type: string
+ - name: nf-role
+ in: query
+ description: role in the network that this model will be providing
+ required: false
+ type: string
+ - name: nf-naming-code
+ in: query
+ description: string assigned to this model used for naming purposes
+ required: false
+ type: string
+ /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ /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:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ /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:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ /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:
+ tags:
+ - Network
+ summary: returns l3-interface-ipv4-address-list
+ description: returns l3-interface-ipv4-address-list
+ operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
+ required: false
+ type: string
+ - name: regional-resource-zone
+ in: query
+ description: Regional way of organizing pservers, source of truth should define values
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ required: false
+ type: boolean
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ - name: nf-type
+ in: query
+ description: Generic description of the type of NF
+ required: false
+ type: string
+ - name: nf-function
+ in: query
+ description: English description of Network function that the specific VNF deployment is providing
+ required: false
+ type: string
+ - name: nf-role
+ in: query
+ description: role in the network that this model will be providing
+ required: false
+ type: string
+ - name: nf-naming-code
+ in: query
+ description: string assigned to this model used for naming purposes
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: vpn-key
+ in: query
+ description: This indicates the customers VPN ID associated with this vlan
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface that address belongs to
+ required: false
+ type: string
+ - name: neutron-subnet-id
+ in: query
+ description: Neutron id of subnet that address belongs to
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing l3-interface-ipv4-address-list
+ description: |
+ Create or update an existing l3-interface-ipv4-address-list.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv4-address-list"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l3-interface-ipv4-address-list
+ description: |
+ Update an existing l3-interface-ipv4-address-list
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing l3-interface-ipv4-address-list
+ description: delete an existing l3-interface-ipv4-address-list
+ operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /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:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ /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:
+ tags:
+ - Network
+ summary: returns l3-interface-ipv6-address-list
+ description: returns l3-interface-ipv6-address-list
+ operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
+ required: false
+ type: string
+ - name: regional-resource-zone
+ in: query
+ description: Regional way of organizing pservers, source of truth should define values
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ required: false
+ type: boolean
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ - name: nf-type
+ in: query
+ description: Generic description of the type of NF
+ required: false
+ type: string
+ - name: nf-function
+ in: query
+ description: English description of Network function that the specific VNF deployment is providing
+ required: false
+ type: string
+ - name: nf-role
+ in: query
+ description: role in the network that this model will be providing
+ required: false
+ type: string
+ - name: nf-naming-code
+ in: query
+ description: string assigned to this model used for naming purposes
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: vpn-key
+ in: query
+ description: This indicates the customers VPN ID associated with this vlan
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface that address belongs to
+ required: false
+ type: string
+ - name: neutron-subnet-id
+ in: query
+ description: Neutron id of subnet that address belongs to
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing l3-interface-ipv6-address-list
+ description: |
+ Create or update an existing l3-interface-ipv6-address-list.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l3-interface-ipv6-address-list
+ description: |
+ Update an existing l3-interface-ipv6-address-list
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing l3-interface-ipv6-address-list
+ description: delete an existing l3-interface-ipv6-address-list
+ operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
+ get:
+ tags:
+ - Network
+ summary: returns vlan
+ description: returns vlan
+ operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/vlan"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
+ required: false
+ type: string
+ - name: regional-resource-zone
+ in: query
+ description: Regional way of organizing pservers, source of truth should define values
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ required: false
+ type: boolean
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ - name: nf-type
+ in: query
+ description: Generic description of the type of NF
+ required: false
+ type: string
+ - name: nf-function
+ in: query
+ description: English description of Network function that the specific VNF deployment is providing
+ required: false
+ type: string
+ - name: nf-role
+ in: query
+ description: role in the network that this model will be providing
+ required: false
+ type: string
+ - name: nf-naming-code
+ in: query
+ description: string assigned to this model used for naming purposes
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: vpn-key
+ in: query
+ description: This indicates the customers VPN ID associated with this vlan
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing vlan
+ description: |
+ Create or update an existing vlan.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: body
+ in: body
+ description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
+ required: true
+ schema:
+ $ref: "#/definitions/vlan"
+ patch:
+ tags:
+ - Network
+ summary: update an existing vlan
+ description: |
+ Update an existing vlan
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: body
+ in: body
+ description: vlan object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/vlan"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing vlan
+ description: delete an existing vlan
+ operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
+ get:
+ tags:
+ - Network
+ summary: returns vlans
+ description: returns vlans
+ operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/vlans"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
+ required: false
+ type: string
+ - name: regional-resource-zone
+ in: query
+ description: Regional way of organizing pservers, source of truth should define values
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ required: false
+ type: boolean
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ - name: nf-type
+ in: query
+ description: Generic description of the type of NF
+ required: false
+ type: string
+ - name: nf-function
+ in: query
+ description: English description of Network function that the specific VNF deployment is providing
+ required: false
+ type: string
+ - name: nf-role
+ in: query
+ description: role in the network that this model will be providing
+ required: false
+ type: string
+ - name: nf-naming-code
+ in: query
+ description: string assigned to this model used for naming purposes
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ /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:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ /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:
+ tags:
+ - Network
+ summary: returns sriov-vf
+ description: returns sriov-vf
+ operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/sriov-vf"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
+ required: false
+ type: string
+ - name: regional-resource-zone
+ in: query
+ description: Regional way of organizing pservers, source of truth should define values
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ required: false
+ type: boolean
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ - name: nf-type
+ in: query
+ description: Generic description of the type of NF
+ required: false
+ type: string
+ - name: nf-function
+ in: query
+ description: English description of Network function that the specific VNF deployment is providing
+ required: false
+ type: string
+ - name: nf-role
+ in: query
+ description: role in the network that this model will be providing
+ required: false
+ type: string
+ - name: nf-naming-code
+ in: query
+ description: string assigned to this model used for naming purposes
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vf-vlan-filter
+ in: query
+ description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
+ required: false
+ type: string
+ - name: vf-mac-filter
+ in: query
+ description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
+ required: false
+ type: string
+ - name: vf-vlan-strip
+ in: query
+ description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
+ required: false
+ type: boolean
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing sriov-vf
+ description: |
+ Create or update an existing sriov-vf.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: body
+ in: body
+ description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
+ required: true
+ schema:
+ $ref: "#/definitions/sriov-vf"
+ patch:
+ tags:
+ - Network
+ summary: update an existing sriov-vf
+ description: |
+ Update an existing sriov-vf
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: body
+ in: body
+ description: sriov-vf object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/sriov-vf"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing sriov-vf
+ description: delete an existing sriov-vf
+ operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
+ get:
+ tags:
+ - Network
+ summary: returns sriov-vfs
+ description: returns sriov-vfs
+ operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/sriov-vfs"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
+ required: false
+ type: string
+ - name: regional-resource-zone
+ in: query
+ description: Regional way of organizing pservers, source of truth should define values
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ required: false
+ type: boolean
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ - name: nf-type
+ in: query
+ description: Generic description of the type of NF
+ required: false
+ type: string
+ - name: nf-function
+ in: query
+ description: English description of Network function that the specific VNF deployment is providing
+ required: false
+ type: string
+ - name: nf-role
+ in: query
+ description: role in the network that this model will be providing
+ required: false
+ type: string
+ - name: nf-naming-code
+ in: query
+ description: string assigned to this model used for naming purposes
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ /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:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ /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:
+ tags:
+ - Network
+ summary: returns l3-interface-ipv4-address-list
+ description: returns l3-interface-ipv4-address-list
+ operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
+ required: false
+ type: string
+ - name: regional-resource-zone
+ in: query
+ description: Regional way of organizing pservers, source of truth should define values
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ required: false
+ type: boolean
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ - name: nf-type
+ in: query
+ description: Generic description of the type of NF
+ required: false
+ type: string
+ - name: nf-function
+ in: query
+ description: English description of Network function that the specific VNF deployment is providing
+ required: false
+ type: string
+ - name: nf-role
+ in: query
+ description: role in the network that this model will be providing
+ required: false
+ type: string
+ - name: nf-naming-code
+ in: query
+ description: string assigned to this model used for naming purposes
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface that address belongs to
+ required: false
+ type: string
+ - name: neutron-subnet-id
+ in: query
+ description: Neutron id of subnet that address belongs to
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing l3-interface-ipv4-address-list
+ description: |
+ Create or update an existing l3-interface-ipv4-address-list.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv4-address-list"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l3-interface-ipv4-address-list
+ description: |
+ Update an existing l3-interface-ipv4-address-list
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing l3-interface-ipv4-address-list
+ description: delete an existing l3-interface-ipv4-address-list
+ operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /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:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ /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:
+ tags:
+ - Network
+ summary: returns l3-interface-ipv6-address-list
+ description: returns l3-interface-ipv6-address-list
+ operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
+ required: false
+ type: string
+ - name: regional-resource-zone
+ in: query
+ description: Regional way of organizing pservers, source of truth should define values
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ required: false
+ type: boolean
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ - name: nf-type
+ in: query
+ description: Generic description of the type of NF
+ required: false
+ type: string
+ - name: nf-function
+ in: query
+ description: English description of Network function that the specific VNF deployment is providing
+ required: false
+ type: string
+ - name: nf-role
+ in: query
+ description: role in the network that this model will be providing
+ required: false
+ type: string
+ - name: nf-naming-code
+ in: query
+ description: string assigned to this model used for naming purposes
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface that address belongs to
+ required: false
+ type: string
+ - name: neutron-subnet-id
+ in: query
+ description: Neutron id of subnet that address belongs to
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing l3-interface-ipv6-address-list
+ description: |
+ Create or update an existing l3-interface-ipv6-address-list.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l3-interface-ipv6-address-list
+ description: |
+ Update an existing l3-interface-ipv6-address-list
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing l3-interface-ipv6-address-list
+ description: delete an existing l3-interface-ipv6-address-list
+ operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
+ get:
+ tags:
+ - Network
+ summary: returns l-interface
+ description: returns l-interface
+ operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l-interface"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
+ required: false
+ type: string
+ - name: regional-resource-zone
+ in: query
+ description: Regional way of organizing pservers, source of truth should define values
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ required: false
+ type: boolean
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ - name: nf-type
+ in: query
+ description: Generic description of the type of NF
+ required: false
+ type: string
+ - name: nf-function
+ in: query
+ description: English description of Network function that the specific VNF deployment is providing
+ required: false
+ type: string
+ - name: nf-role
+ in: query
+ description: role in the network that this model will be providing
+ required: false
+ type: string
+ - name: nf-naming-code
+ in: query
+ description: string assigned to this model used for naming purposes
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing l-interface
+ description: |
+ Create or update an existing l-interface.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l-interface"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l-interface
+ description: |
+ Update an existing l-interface
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: l-interface object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l-interface"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing l-interface
+ description: delete an existing l-interface
+ operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
+ get:
+ tags:
+ - Network
+ summary: returns l-interfaces
+ description: returns l-interfaces
+ operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfaces
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l-interfaces"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
+ required: false
+ type: string
+ - name: regional-resource-zone
+ in: query
+ description: Regional way of organizing pservers, source of truth should define values
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ required: false
+ type: boolean
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ - name: nf-type
+ in: query
+ description: Generic description of the type of NF
+ required: false
+ type: string
+ - name: nf-function
+ in: query
+ description: English description of Network function that the specific VNF deployment is providing
+ required: false
+ type: string
+ - name: nf-role
+ in: query
+ description: role in the network that this model will be providing
+ required: false
+ type: string
+ - name: nf-naming-code
+ in: query
+ description: string assigned to this model used for naming purposes
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ required: false
+ type: string
+ /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}:
+ get:
+ tags:
+ - Network
+ summary: returns lag-interface
+ description: returns lag-interface
+ operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/lag-interface"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
+ required: false
+ type: string
+ - name: regional-resource-zone
+ in: query
+ description: Regional way of organizing pservers, source of truth should define values
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ required: false
+ type: boolean
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ - name: nf-type
+ in: query
+ description: Generic description of the type of NF
+ required: false
+ type: string
+ - name: nf-function
+ in: query
+ description: English description of Network function that the specific VNF deployment is providing
+ required: false
+ type: string
+ - name: nf-role
+ in: query
+ description: role in the network that this model will be providing
+ required: false
+ type: string
+ - name: nf-naming-code
+ in: query
+ description: string assigned to this model used for naming purposes
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing lag-interface
+ description: |
+ Create or update an existing lag-interface.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)
+ required: true
+ schema:
+ $ref: "#/definitions/lag-interface"
+ patch:
+ tags:
+ - Network
+ summary: update an existing lag-interface
+ description: |
+ Update an existing lag-interface
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: lag-interface object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/lag-interface"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing lag-interface
+ description: delete an existing lag-interface
+ operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces:
+ get:
+ tags:
+ - Network
+ summary: returns lag-interfaces
+ description: returns lag-interfaces
+ operationId: getNetworkGenericVnfsGenericVnfLagInterfaces
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/lag-interfaces"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
+ required: false
+ type: string
+ - name: regional-resource-zone
+ in: query
+ description: Regional way of organizing pservers, source of truth should define values
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ required: false
+ type: boolean
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ - name: nf-type
+ in: query
+ description: Generic description of the type of NF
+ required: false
+ type: string
+ - name: nf-function
+ in: query
+ description: English description of Network function that the specific VNF deployment is providing
+ required: false
+ type: string
+ - name: nf-role
+ in: query
+ description: role in the network that this model will be providing
+ required: false
+ type: string
+ - name: nf-naming-code
+ in: query
+ description: string assigned to this model used for naming purposes
+ required: false
+ type: string
+ /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: vf-module-id
+ in: path
+ description: Unique ID of vf-module.
+ required: true
+ type: string
+ example: __VF-MODULE-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: vf-module-id
+ in: path
+ description: Unique ID of vf-module.
+ required: true
+ type: string
+ example: __VF-MODULE-ID__
+ /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}:
+ get:
+ tags:
+ - Network
+ summary: returns vf-module
+ description: returns vf-module
+ operationId: getNetworkGenericVnfsGenericVnfVfModulesVfModule
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/vf-module"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: vf-module-id
+ in: path
+ description: Unique ID of vf-module.
+ required: true
+ type: string
+ example: __VF-MODULE-ID__
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
+ required: false
+ type: string
+ - name: regional-resource-zone
+ in: query
+ description: Regional way of organizing pservers, source of truth should define values
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ required: false
+ type: boolean
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ - name: nf-type
+ in: query
+ description: Generic description of the type of NF
+ required: false
+ type: string
+ - name: nf-function
+ in: query
+ description: English description of Network function that the specific VNF deployment is providing
+ required: false
+ type: string
+ - name: nf-role
+ in: query
+ description: role in the network that this model will be providing
+ required: false
+ type: string
+ - name: nf-naming-code
+ in: query
+ description: string assigned to this model used for naming purposes
+ required: false
+ type: string
+ - name: vf-module-name
+ in: query
+ description: Name of vf-module
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance.
+ required: false
+ type: string
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ - name: contrail-service-instance-fqdn
+ in: query
+ description: the Contrail unique ID for a service-instance
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing vf-module
+ description: |
+ Create or update an existing vf-module.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModule
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: vf-module-id
+ in: path
+ description: Unique ID of vf-module.
+ required: true
+ type: string
+ example: __VF-MODULE-ID__
+ - name: body
+ in: body
+ description: vf-module object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)
+ required: true
+ schema:
+ $ref: "#/definitions/vf-module"
+ patch:
+ tags:
+ - Network
+ summary: update an existing vf-module
+ description: |
+ Update an existing vf-module
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkGenericVnfsGenericVnfVfModulesVfModule
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: vf-module-id
+ in: path
+ description: Unique ID of vf-module.
+ required: true
+ type: string
+ example: __VF-MODULE-ID__
+ - name: body
+ in: body
+ description: vf-module object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/vf-module"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing vf-module
+ description: delete an existing vf-module
+ operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModule
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: vf-module-id
+ in: path
+ description: Unique ID of vf-module.
+ required: true
+ type: string
+ example: __VF-MODULE-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules:
+ get:
+ tags:
+ - Network
+ summary: returns vf-modules
+ description: returns vf-modules
+ operationId: getNetworkGenericVnfsGenericVnfVfModules
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/vf-modules"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
+ required: false
+ type: string
+ - name: regional-resource-zone
+ in: query
+ description: Regional way of organizing pservers, source of truth should define values
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ required: false
+ type: boolean
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ - name: nf-type
+ in: query
+ description: Generic description of the type of NF
+ required: false
+ type: string
+ - name: nf-function
+ in: query
+ description: English description of Network function that the specific VNF deployment is providing
+ required: false
+ type: string
+ - name: nf-role
+ in: query
+ description: role in the network that this model will be providing
+ required: false
+ type: string
+ - name: nf-naming-code
+ in: query
+ description: string assigned to this model used for naming purposes
+ required: false
+ type: string
+ /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: group-uuid
+ in: path
+ description: Unique ID for the license group the resource belongs to, should be uuid.
+ required: true
+ type: string
+ example: __GROUP-UUID__
+ - name: resource-uuid
+ in: path
+ description: Unique ID of a license resource.
+ required: true
+ type: string
+ example: __RESOURCE-UUID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLicensesLicense.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: group-uuid
+ in: path
+ description: Unique ID for the license group the resource belongs to, should be uuid.
+ required: true
+ type: string
+ example: __GROUP-UUID__
+ - name: resource-uuid
+ in: path
+ description: Unique ID of a license resource.
+ required: true
+ type: string
+ example: __RESOURCE-UUID__
+ /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}:
+ get:
+ tags:
+ - Network
+ summary: returns license
+ description: returns license
+ operationId: getNetworkGenericVnfsGenericVnfLicensesLicense
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/license"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: group-uuid
+ in: path
+ description: Unique ID for the license group the resource belongs to, should be uuid.
+ required: true
+ type: string
+ example: __GROUP-UUID__
+ - name: resource-uuid
+ in: path
+ description: Unique ID of a license resource.
+ required: true
+ type: string
+ example: __RESOURCE-UUID__
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
+ required: false
+ type: string
+ - name: regional-resource-zone
+ in: query
+ description: Regional way of organizing pservers, source of truth should define values
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ required: false
+ type: boolean
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ - name: nf-type
+ in: query
+ description: Generic description of the type of NF
+ required: false
+ type: string
+ - name: nf-function
+ in: query
+ description: English description of Network function that the specific VNF deployment is providing
+ required: false
+ type: string
+ - name: nf-role
+ in: query
+ description: role in the network that this model will be providing
+ required: false
+ type: string
+ - name: nf-naming-code
+ in: query
+ description: string assigned to this model used for naming purposes
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing license
+ description: |
+ Create or update an existing license.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicense
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: group-uuid
+ in: path
+ description: Unique ID for the license group the resource belongs to, should be uuid.
+ required: true
+ type: string
+ example: __GROUP-UUID__
+ - name: resource-uuid
+ in: path
+ description: Unique ID of a license resource.
+ required: true
+ type: string
+ example: __RESOURCE-UUID__
+ - name: body
+ in: body
+ description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLicensesLicense.json)
+ required: true
+ schema:
+ $ref: "#/definitions/license"
+ patch:
+ tags:
+ - Network
+ summary: update an existing license
+ description: |
+ Update an existing license
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkGenericVnfsGenericVnfLicensesLicense
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: group-uuid
+ in: path
+ description: Unique ID for the license group the resource belongs to, should be uuid.
+ required: true
+ type: string
+ example: __GROUP-UUID__
+ - name: resource-uuid
+ in: path
+ description: Unique ID of a license resource.
+ required: true
+ type: string
+ example: __RESOURCE-UUID__
+ - name: body
+ in: body
+ description: license object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/license"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing license
+ description: delete an existing license
+ operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicense
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: group-uuid
+ in: path
+ description: Unique ID for the license group the resource belongs to, should be uuid.
+ required: true
+ type: string
+ example: __GROUP-UUID__
+ - name: resource-uuid
+ in: path
+ description: Unique ID of a license resource.
+ required: true
+ type: string
+ example: __RESOURCE-UUID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/generic-vnfs/generic-vnf/{vnf-id}/licenses:
+ get:
+ tags:
+ - Network
+ summary: returns licenses
+ description: returns licenses
+ operationId: getNetworkGenericVnfsGenericVnfLicenses
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/licenses"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
+ required: false
+ type: string
+ - name: regional-resource-zone
+ in: query
+ description: Regional way of organizing pservers, source of truth should define values
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ required: false
+ type: boolean
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ - name: nf-type
+ in: query
+ description: Generic description of the type of NF
+ required: false
+ type: string
+ - name: nf-function
+ in: query
+ description: English description of Network function that the specific VNF deployment is providing
+ required: false
+ type: string
+ - name: nf-role
+ in: query
+ description: role in the network that this model will be providing
+ required: false
+ type: string
+ - name: nf-naming-code
+ in: query
+ description: string assigned to this model used for naming purposes
+ required: false
+ type: string
+ /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: group-uuid
+ in: path
+ description: Unique ID for the entitlement group the resource comes from, should be uuid.
+ required: true
+ type: string
+ example: __GROUP-UUID__
+ - name: resource-uuid
+ in: path
+ description: Unique ID of an entitlement resource.
+ required: true
+ type: string
+ example: __RESOURCE-UUID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: group-uuid
+ in: path
+ description: Unique ID for the entitlement group the resource comes from, should be uuid.
+ required: true
+ type: string
+ example: __GROUP-UUID__
+ - name: resource-uuid
+ in: path
+ description: Unique ID of an entitlement resource.
+ required: true
+ type: string
+ example: __RESOURCE-UUID__
+ /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}:
+ get:
+ tags:
+ - Network
+ summary: returns entitlement
+ description: returns entitlement
+ operationId: getNetworkGenericVnfsGenericVnfEntitlementsEntitlement
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/entitlement"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: group-uuid
+ in: path
+ description: Unique ID for the entitlement group the resource comes from, should be uuid.
+ required: true
+ type: string
+ example: __GROUP-UUID__
+ - name: resource-uuid
+ in: path
+ description: Unique ID of an entitlement resource.
+ required: true
+ type: string
+ example: __RESOURCE-UUID__
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
+ required: false
+ type: string
+ - name: regional-resource-zone
+ in: query
+ description: Regional way of organizing pservers, source of truth should define values
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ required: false
+ type: boolean
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ - name: nf-type
+ in: query
+ description: Generic description of the type of NF
+ required: false
+ type: string
+ - name: nf-function
+ in: query
+ description: English description of Network function that the specific VNF deployment is providing
+ required: false
+ type: string
+ - name: nf-role
+ in: query
+ description: role in the network that this model will be providing
+ required: false
+ type: string
+ - name: nf-naming-code
+ in: query
+ description: string assigned to this model used for naming purposes
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing entitlement
+ description: |
+ Create or update an existing entitlement.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: group-uuid
+ in: path
+ description: Unique ID for the entitlement group the resource comes from, should be uuid.
+ required: true
+ type: string
+ example: __GROUP-UUID__
+ - name: resource-uuid
+ in: path
+ description: Unique ID of an entitlement resource.
+ required: true
+ type: string
+ example: __RESOURCE-UUID__
+ - name: body
+ in: body
+ description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)
+ required: true
+ schema:
+ $ref: "#/definitions/entitlement"
+ patch:
+ tags:
+ - Network
+ summary: update an existing entitlement
+ description: |
+ Update an existing entitlement
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: group-uuid
+ in: path
+ description: Unique ID for the entitlement group the resource comes from, should be uuid.
+ required: true
+ type: string
+ example: __GROUP-UUID__
+ - name: resource-uuid
+ in: path
+ description: Unique ID of an entitlement resource.
+ required: true
+ type: string
+ example: __RESOURCE-UUID__
+ - name: body
+ in: body
+ description: entitlement object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/entitlement"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing entitlement
+ description: delete an existing entitlement
+ operationId: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlement
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: group-uuid
+ in: path
+ description: Unique ID for the entitlement group the resource comes from, should be uuid.
+ required: true
+ type: string
+ example: __GROUP-UUID__
+ - name: resource-uuid
+ in: path
+ description: Unique ID of an entitlement resource.
+ required: true
+ type: string
+ example: __RESOURCE-UUID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements:
+ get:
+ tags:
+ - Network
+ summary: returns entitlements
+ description: returns entitlements
+ operationId: getNetworkGenericVnfsGenericVnfEntitlements
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/entitlements"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
+ required: false
+ type: string
+ - name: regional-resource-zone
+ in: query
+ description: Regional way of organizing pservers, source of truth should define values
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ required: false
+ type: boolean
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ - name: nf-type
+ in: query
+ description: Generic description of the type of NF
+ required: false
+ type: string
+ - name: nf-function
+ in: query
+ description: English description of Network function that the specific VNF deployment is providing
+ required: false
+ type: string
+ - name: nf-role
+ in: query
+ description: role in the network that this model will be providing
+ required: false
+ type: string
+ - name: nf-naming-code
+ in: query
+ description: string assigned to this model used for naming purposes
+ required: false
+ type: string
+ /network/generic-vnfs/generic-vnf/{vnf-id}:
+ get:
+ tags:
+ - Network
+ summary: returns generic-vnf
+ description: returns generic-vnf
+ operationId: getNetworkGenericVnfsGenericVnf
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/generic-vnf"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
+ required: false
+ type: string
+ - name: regional-resource-zone
+ in: query
+ description: Regional way of organizing pservers, source of truth should define values
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: in-maint
+ in: query
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ required: false
+ type: boolean
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ - name: nf-type
+ in: query
+ description: Generic description of the type of NF
+ required: false
+ type: string
+ - name: nf-function
+ in: query
+ description: English description of Network function that the specific VNF deployment is providing
+ required: false
+ type: string
+ - name: nf-role
+ in: query
+ description: role in the network that this model will be providing
+ required: false
+ type: string
+ - name: nf-naming-code
+ in: query
+ description: string assigned to this model used for naming purposes
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing generic-vnf
+ description: |
+ Create or update an existing generic-vnf.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkGenericVnfsGenericVnf
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: body
+ in: body
+ description: generic-vnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnf.json)
+ required: true
+ schema:
+ $ref: "#/definitions/generic-vnf"
+ patch:
+ tags:
+ - Network
+ summary: update an existing generic-vnf
+ description: |
+ Update an existing generic-vnf
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkGenericVnfsGenericVnf
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: body
+ in: body
+ description: generic-vnf object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/generic-vnf"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing generic-vnf
+ description: delete an existing generic-vnf
+ operationId: deleteNetworkGenericVnfsGenericVnf
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ example: __VNF-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/generic-vnfs:
+ get:
+ tags:
+ - Network
+ summary: returns generic-vnfs
+ description: returns generic-vnfs
+ operationId: getNetworkGenericVnfs
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/generic-vnfs"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /network/lag-links/lag-link/{link-name}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkLagLinksLagLinkRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: link-name
+ in: path
+ description: Alphabetical concatenation of lag-interface names
+ required: true
+ type: string
+ example: __LINK-NAME__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkLagLinksLagLink.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkLagLinksLagLinkRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: link-name
+ in: path
+ description: Alphabetical concatenation of lag-interface names
+ required: true
+ type: string
+ example: __LINK-NAME__
+ /network/lag-links/lag-link/{link-name}:
+ get:
+ tags:
+ - Network
+ summary: returns lag-link
+ description: returns lag-link
+ operationId: getNetworkLagLinksLagLink
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/lag-link"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: link-name
+ in: path
+ description: Alphabetical concatenation of lag-interface names
+ required: true
+ type: string
+ example: __LINK-NAME__
+ put:
+ tags:
+ - Network
+ summary: create or update an existing lag-link
+ description: |
+ Create or update an existing lag-link.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkLagLinksLagLink
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: link-name
+ in: path
+ description: Alphabetical concatenation of lag-interface names
+ required: true
+ type: string
+ example: __LINK-NAME__
+ - name: body
+ in: body
+ description: lag-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkLagLinksLagLink.json)
+ required: true
+ schema:
+ $ref: "#/definitions/lag-link"
+ patch:
+ tags:
+ - Network
+ summary: update an existing lag-link
+ description: |
+ Update an existing lag-link
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkLagLinksLagLink
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: link-name
+ in: path
+ description: Alphabetical concatenation of lag-interface names
+ required: true
+ type: string
+ example: __LINK-NAME__
+ - name: body
+ in: body
+ description: lag-link object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/lag-link"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing lag-link
+ description: delete an existing lag-link
+ operationId: deleteNetworkLagLinksLagLink
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: link-name
+ in: path
+ description: Alphabetical concatenation of lag-interface names
+ required: true
+ type: string
+ example: __LINK-NAME__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/lag-links:
+ get:
+ tags:
+ - Network
+ summary: returns lag-links
+ description: returns lag-links
+ operationId: getNetworkLagLinks
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/lag-links"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /network/newvces/newvce/{vnf-id2}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkNewvcesNewvceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: path
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ required: true
+ type: string
+ example: __VNF-ID2__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvce.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkNewvcesNewvceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: path
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ required: true
+ type: string
+ example: __VNF-ID2__
+ /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: path
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ required: true
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: path
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ required: true
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ /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:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: path
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ required: true
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: path
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ required: true
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ /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:
+ tags:
+ - Network
+ summary: returns l3-interface-ipv4-address-list
+ description: returns l3-interface-ipv4-address-list
+ operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: path
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ required: true
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: vpn-key
+ in: query
+ description: This indicates the customers VPN ID associated with this vlan
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface that address belongs to
+ required: false
+ type: string
+ - name: neutron-subnet-id
+ in: query
+ description: Neutron id of subnet that address belongs to
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing l3-interface-ipv4-address-list
+ description: |
+ Create or update an existing l3-interface-ipv4-address-list.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: path
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ required: true
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv4-address-list"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l3-interface-ipv4-address-list
+ description: |
+ Update an existing l3-interface-ipv4-address-list
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: path
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ required: true
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing l3-interface-ipv4-address-list
+ description: delete an existing l3-interface-ipv4-address-list
+ operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: path
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ required: true
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /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:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: path
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ required: true
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: path
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ required: true
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ /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:
+ tags:
+ - Network
+ summary: returns l3-interface-ipv6-address-list
+ description: returns l3-interface-ipv6-address-list
+ operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: path
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ required: true
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: vpn-key
+ in: query
+ description: This indicates the customers VPN ID associated with this vlan
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface that address belongs to
+ required: false
+ type: string
+ - name: neutron-subnet-id
+ in: query
+ description: Neutron id of subnet that address belongs to
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing l3-interface-ipv6-address-list
+ description: |
+ Create or update an existing l3-interface-ipv6-address-list.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: path
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ required: true
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l3-interface-ipv6-address-list
+ description: |
+ Update an existing l3-interface-ipv6-address-list
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: path
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ required: true
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing l3-interface-ipv6-address-list
+ description: delete an existing l3-interface-ipv6-address-list
+ operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: path
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ required: true
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
+ get:
+ tags:
+ - Network
+ summary: returns vlan
+ description: returns vlan
+ operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/vlan"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: path
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ required: true
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: vpn-key
+ in: query
+ description: This indicates the customers VPN ID associated with this vlan
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing vlan
+ description: |
+ Create or update an existing vlan.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: path
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ required: true
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: body
+ in: body
+ description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)
+ required: true
+ schema:
+ $ref: "#/definitions/vlan"
+ patch:
+ tags:
+ - Network
+ summary: update an existing vlan
+ description: |
+ Update an existing vlan
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: path
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ required: true
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: body
+ in: body
+ description: vlan object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/vlan"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing vlan
+ description: delete an existing vlan
+ operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: path
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ required: true
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans:
+ get:
+ tags:
+ - Network
+ summary: returns vlans
+ description: returns vlans
+ operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlans
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/vlans"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: path
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ required: true
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: path
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ required: true
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: path
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ required: true
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
+ get:
+ tags:
+ - Network
+ summary: returns sriov-vf
+ description: returns sriov-vf
+ operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/sriov-vf"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: path
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ required: true
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vf-vlan-filter
+ in: query
+ description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
+ required: false
+ type: string
+ - name: vf-mac-filter
+ in: query
+ description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
+ required: false
+ type: string
+ - name: vf-vlan-strip
+ in: query
+ description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
+ required: false
+ type: boolean
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing sriov-vf
+ description: |
+ Create or update an existing sriov-vf.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: path
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ required: true
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: body
+ in: body
+ description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
+ required: true
+ schema:
+ $ref: "#/definitions/sriov-vf"
+ patch:
+ tags:
+ - Network
+ summary: update an existing sriov-vf
+ description: |
+ Update an existing sriov-vf
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: path
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ required: true
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: body
+ in: body
+ description: sriov-vf object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/sriov-vf"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing sriov-vf
+ description: delete an existing sriov-vf
+ operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: path
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ required: true
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
+ get:
+ tags:
+ - Network
+ summary: returns sriov-vfs
+ description: returns sriov-vfs
+ operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfs
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/sriov-vfs"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: path
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ required: true
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: path
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ required: true
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterface.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: path
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ required: true
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: path
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ required: true
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: path
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ required: true
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
+ get:
+ tags:
+ - Network
+ summary: returns l3-interface-ipv4-address-list
+ description: returns l3-interface-ipv4-address-list
+ operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: path
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ required: true
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface that address belongs to
+ required: false
+ type: string
+ - name: neutron-subnet-id
+ in: query
+ description: Neutron id of subnet that address belongs to
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing l3-interface-ipv4-address-list
+ description: |
+ Create or update an existing l3-interface-ipv4-address-list.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: path
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ required: true
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv4-address-list"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l3-interface-ipv4-address-list
+ description: |
+ Update an existing l3-interface-ipv4-address-list
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: path
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ required: true
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing l3-interface-ipv4-address-list
+ description: delete an existing l3-interface-ipv4-address-list
+ operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: path
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ required: true
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: path
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ required: true
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: path
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ required: true
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
+ get:
+ tags:
+ - Network
+ summary: returns l3-interface-ipv6-address-list
+ description: returns l3-interface-ipv6-address-list
+ operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: path
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ required: true
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface that address belongs to
+ required: false
+ type: string
+ - name: neutron-subnet-id
+ in: query
+ description: Neutron id of subnet that address belongs to
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing l3-interface-ipv6-address-list
+ description: |
+ Create or update an existing l3-interface-ipv6-address-list.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: path
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ required: true
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l3-interface-ipv6-address-list
+ description: |
+ Update an existing l3-interface-ipv6-address-list
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: path
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ required: true
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing l3-interface-ipv6-address-list
+ description: delete an existing l3-interface-ipv6-address-list
+ operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: path
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ required: true
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}:
+ get:
+ tags:
+ - Network
+ summary: returns l-interface
+ description: returns l-interface
+ operationId: getNetworkNewvcesNewvceLInterfacesLInterface
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l-interface"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: path
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ required: true
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing l-interface
+ description: |
+ Create or update an existing l-interface.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: path
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ required: true
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterface.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l-interface"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l-interface
+ description: |
+ Update an existing l-interface
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: path
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ required: true
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: l-interface object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l-interface"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing l-interface
+ description: delete an existing l-interface
+ operationId: deleteNetworkNewvcesNewvceLInterfacesLInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: path
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ required: true
+ type: string
+ example: __VNF-ID2__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/newvces/newvce/{vnf-id2}/l-interfaces:
+ get:
+ tags:
+ - Network
+ summary: returns l-interfaces
+ description: returns l-interfaces
+ operationId: getNetworkNewvcesNewvceLInterfaces
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l-interfaces"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: path
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ required: true
+ type: string
+ example: __VNF-ID2__
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ /network/newvces/newvce/{vnf-id2}:
+ get:
+ tags:
+ - Network
+ summary: returns newvce
+ description: returns newvce
+ operationId: getNetworkNewvcesNewvce
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/newvce"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: path
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ required: true
+ type: string
+ example: __VNF-ID2__
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing newvce
+ description: |
+ Create or update an existing newvce.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkNewvcesNewvce
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: path
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ required: true
+ type: string
+ example: __VNF-ID2__
+ - name: body
+ in: body
+ description: newvce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvce.json)
+ required: true
+ schema:
+ $ref: "#/definitions/newvce"
+ patch:
+ tags:
+ - Network
+ summary: update an existing newvce
+ description: |
+ Update an existing newvce
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkNewvcesNewvce
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: path
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ required: true
+ type: string
+ example: __VNF-ID2__
+ - name: body
+ in: body
+ description: newvce object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/newvce"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing newvce
+ description: delete an existing newvce
+ operationId: deleteNetworkNewvcesNewvce
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id2
+ in: path
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ required: true
+ type: string
+ example: __VNF-ID2__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/newvces:
+ get:
+ tags:
+ - Network
+ summary: returns newvces
+ description: returns newvces
+ operationId: getNetworkNewvces
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/newvces"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /network/pnfs/pnf/{pnf-name}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkPnfsPnfRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnf.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkPnfsPnfRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterface.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pf-pci-id
+ in: path
+ description: Identifier for the sriov-pf
+ required: true
+ type: string
+ example: __PF-PCI-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pf-pci-id
+ in: path
+ description: Identifier for the sriov-pf
+ required: true
+ type: string
+ example: __PF-PCI-ID__
+ /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}:
+ get:
+ tags:
+ - Network
+ summary: returns sriov-pf
+ description: returns sriov-pf
+ operationId: getNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/sriov-pf"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pf-pci-id
+ in: path
+ description: Identifier for the sriov-pf
+ required: true
+ type: string
+ example: __PF-PCI-ID__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing sriov-pf
+ description: |
+ Create or update an existing sriov-pf.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pf-pci-id
+ in: path
+ description: Identifier for the sriov-pf
+ required: true
+ type: string
+ example: __PF-PCI-ID__
+ - name: body
+ in: body
+ description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf.json)
+ required: true
+ schema:
+ $ref: "#/definitions/sriov-pf"
+ patch:
+ tags:
+ - Network
+ summary: update an existing sriov-pf
+ description: |
+ Update an existing sriov-pf
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pf-pci-id
+ in: path
+ description: Identifier for the sriov-pf
+ required: true
+ type: string
+ example: __PF-PCI-ID__
+ - name: body
+ in: body
+ description: sriov-pf object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/sriov-pf"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing sriov-pf
+ description: delete an existing sriov-pf
+ operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pf-pci-id
+ in: path
+ description: Identifier for the sriov-pf
+ required: true
+ type: string
+ example: __PF-PCI-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs:
+ get:
+ tags:
+ - Network
+ summary: returns sriov-pfs
+ description: returns sriov-pfs
+ operationId: getNetworkPnfsPnfPInterfacesPInterfaceSriovPfs
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/sriov-pfs"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ /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:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ /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:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ /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:
+ tags:
+ - Network
+ summary: returns l3-interface-ipv4-address-list
+ description: returns l3-interface-ipv4-address-list
+ operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: vpn-key
+ in: query
+ description: This indicates the customers VPN ID associated with this vlan
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface that address belongs to
+ required: false
+ type: string
+ - name: neutron-subnet-id
+ in: query
+ description: Neutron id of subnet that address belongs to
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing l3-interface-ipv4-address-list
+ description: |
+ Create or update an existing l3-interface-ipv4-address-list.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv4-address-list"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l3-interface-ipv4-address-list
+ description: |
+ Update an existing l3-interface-ipv4-address-list
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing l3-interface-ipv4-address-list
+ description: delete an existing l3-interface-ipv4-address-list
+ operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /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:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ /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:
+ tags:
+ - Network
+ summary: returns l3-interface-ipv6-address-list
+ description: returns l3-interface-ipv6-address-list
+ operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: vpn-key
+ in: query
+ description: This indicates the customers VPN ID associated with this vlan
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface that address belongs to
+ required: false
+ type: string
+ - name: neutron-subnet-id
+ in: query
+ description: Neutron id of subnet that address belongs to
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing l3-interface-ipv6-address-list
+ description: |
+ Create or update an existing l3-interface-ipv6-address-list.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l3-interface-ipv6-address-list
+ description: |
+ Update an existing l3-interface-ipv6-address-list
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing l3-interface-ipv6-address-list
+ description: delete an existing l3-interface-ipv6-address-list
+ operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
+ get:
+ tags:
+ - Network
+ summary: returns vlan
+ description: returns vlan
+ operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/vlan"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: vpn-key
+ in: query
+ description: This indicates the customers VPN ID associated with this vlan
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing vlan
+ description: |
+ Create or update an existing vlan.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: body
+ in: body
+ description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
+ required: true
+ schema:
+ $ref: "#/definitions/vlan"
+ patch:
+ tags:
+ - Network
+ summary: update an existing vlan
+ description: |
+ Update an existing vlan
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: body
+ in: body
+ description: vlan object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/vlan"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing vlan
+ description: delete an existing vlan
+ operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
+ get:
+ tags:
+ - Network
+ summary: returns vlans
+ description: returns vlans
+ operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlans
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/vlans"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ /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:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
+ get:
+ tags:
+ - Network
+ summary: returns sriov-vf
+ description: returns sriov-vf
+ operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/sriov-vf"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vf-vlan-filter
+ in: query
+ description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
+ required: false
+ type: string
+ - name: vf-mac-filter
+ in: query
+ description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
+ required: false
+ type: string
+ - name: vf-vlan-strip
+ in: query
+ description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
+ required: false
+ type: boolean
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing sriov-vf
+ description: |
+ Create or update an existing sriov-vf.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: body
+ in: body
+ description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
+ required: true
+ schema:
+ $ref: "#/definitions/sriov-vf"
+ patch:
+ tags:
+ - Network
+ summary: update an existing sriov-vf
+ description: |
+ Update an existing sriov-vf
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: body
+ in: body
+ description: sriov-vf object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/sriov-vf"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing sriov-vf
+ description: delete an existing sriov-vf
+ operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
+ get:
+ tags:
+ - Network
+ summary: returns sriov-vfs
+ description: returns sriov-vfs
+ operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/sriov-vfs"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ /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:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ /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:
+ tags:
+ - Network
+ summary: returns l3-interface-ipv4-address-list
+ description: returns l3-interface-ipv4-address-list
+ operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface that address belongs to
+ required: false
+ type: string
+ - name: neutron-subnet-id
+ in: query
+ description: Neutron id of subnet that address belongs to
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing l3-interface-ipv4-address-list
+ description: |
+ Create or update an existing l3-interface-ipv4-address-list.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv4-address-list"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l3-interface-ipv4-address-list
+ description: |
+ Update an existing l3-interface-ipv4-address-list
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing l3-interface-ipv4-address-list
+ description: delete an existing l3-interface-ipv4-address-list
+ operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /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:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ /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:
+ tags:
+ - Network
+ summary: returns l3-interface-ipv6-address-list
+ description: returns l3-interface-ipv6-address-list
+ operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface that address belongs to
+ required: false
+ type: string
+ - name: neutron-subnet-id
+ in: query
+ description: Neutron id of subnet that address belongs to
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing l3-interface-ipv6-address-list
+ description: |
+ Create or update an existing l3-interface-ipv6-address-list.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l3-interface-ipv6-address-list
+ description: |
+ Update an existing l3-interface-ipv6-address-list
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing l3-interface-ipv6-address-list
+ description: delete an existing l3-interface-ipv6-address-list
+ operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
+ get:
+ tags:
+ - Network
+ summary: returns l-interface
+ description: returns l-interface
+ operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l-interface"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing l-interface
+ description: |
+ Create or update an existing l-interface.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l-interface"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l-interface
+ description: |
+ Update an existing l-interface
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: l-interface object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l-interface"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing l-interface
+ description: delete an existing l-interface
+ operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces:
+ get:
+ tags:
+ - Network
+ summary: returns l-interfaces
+ description: returns l-interfaces
+ operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfaces
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l-interfaces"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}:
+ get:
+ tags:
+ - Network
+ summary: returns p-interface
+ description: returns p-interface
+ operationId: getNetworkPnfsPnfPInterfacesPInterface
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/p-interface"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing p-interface
+ description: |
+ Create or update an existing p-interface.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterface.json)
+ required: true
+ schema:
+ $ref: "#/definitions/p-interface"
+ patch:
+ tags:
+ - Network
+ summary: update an existing p-interface
+ description: |
+ Update an existing p-interface
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkPnfsPnfPInterfacesPInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: p-interface object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/p-interface"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing p-interface
+ description: delete an existing p-interface
+ operationId: deleteNetworkPnfsPnfPInterfacesPInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the physical interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/pnfs/pnf/{pnf-name}/p-interfaces:
+ get:
+ tags:
+ - Network
+ summary: returns p-interfaces
+ description: returns p-interfaces
+ operationId: getNetworkPnfsPnfPInterfaces
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/p-interfaces"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterface.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ /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:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ /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:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ /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:
+ tags:
+ - Network
+ summary: returns l3-interface-ipv4-address-list
+ description: returns l3-interface-ipv4-address-list
+ operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: vpn-key
+ in: query
+ description: This indicates the customers VPN ID associated with this vlan
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface that address belongs to
+ required: false
+ type: string
+ - name: neutron-subnet-id
+ in: query
+ description: Neutron id of subnet that address belongs to
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing l3-interface-ipv4-address-list
+ description: |
+ Create or update an existing l3-interface-ipv4-address-list.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv4-address-list"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l3-interface-ipv4-address-list
+ description: |
+ Update an existing l3-interface-ipv4-address-list
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing l3-interface-ipv4-address-list
+ description: delete an existing l3-interface-ipv4-address-list
+ operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /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:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ /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:
+ tags:
+ - Network
+ summary: returns l3-interface-ipv6-address-list
+ description: returns l3-interface-ipv6-address-list
+ operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: vpn-key
+ in: query
+ description: This indicates the customers VPN ID associated with this vlan
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface that address belongs to
+ required: false
+ type: string
+ - name: neutron-subnet-id
+ in: query
+ description: Neutron id of subnet that address belongs to
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing l3-interface-ipv6-address-list
+ description: |
+ Create or update an existing l3-interface-ipv6-address-list.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l3-interface-ipv6-address-list
+ description: |
+ Update an existing l3-interface-ipv6-address-list
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing l3-interface-ipv6-address-list
+ description: delete an existing l3-interface-ipv6-address-list
+ operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
+ get:
+ tags:
+ - Network
+ summary: returns vlan
+ description: returns vlan
+ operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/vlan"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: vpn-key
+ in: query
+ description: This indicates the customers VPN ID associated with this vlan
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing vlan
+ description: |
+ Create or update an existing vlan.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: body
+ in: body
+ description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
+ required: true
+ schema:
+ $ref: "#/definitions/vlan"
+ patch:
+ tags:
+ - Network
+ summary: update an existing vlan
+ description: |
+ Update an existing vlan
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: body
+ in: body
+ description: vlan object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/vlan"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing vlan
+ description: delete an existing vlan
+ operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: vlan-interface
+ in: path
+ description: String that identifies the interface
+ required: true
+ type: string
+ example: __VLAN-INTERFACE__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
+ get:
+ tags:
+ - Network
+ summary: returns vlans
+ description: returns vlans
+ operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/vlans"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ /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:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
+ get:
+ tags:
+ - Network
+ summary: returns sriov-vf
+ description: returns sriov-vf
+ operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/sriov-vf"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vf-vlan-filter
+ in: query
+ description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
+ required: false
+ type: string
+ - name: vf-mac-filter
+ in: query
+ description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
+ required: false
+ type: string
+ - name: vf-vlan-strip
+ in: query
+ description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
+ required: false
+ type: boolean
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing sriov-vf
+ description: |
+ Create or update an existing sriov-vf.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: body
+ in: body
+ description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
+ required: true
+ schema:
+ $ref: "#/definitions/sriov-vf"
+ patch:
+ tags:
+ - Network
+ summary: update an existing sriov-vf
+ description: |
+ Update an existing sriov-vf
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: body
+ in: body
+ description: sriov-vf object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/sriov-vf"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing sriov-vf
+ description: delete an existing sriov-vf
+ operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: pci-id
+ in: path
+ description: PCI ID used to identify the sriov-vf
+ required: true
+ type: string
+ example: __PCI-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
+ get:
+ tags:
+ - Network
+ summary: returns sriov-vfs
+ description: returns sriov-vfs
+ operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/sriov-vfs"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ /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:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ /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:
+ tags:
+ - Network
+ summary: returns l3-interface-ipv4-address-list
+ description: returns l3-interface-ipv4-address-list
+ operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface that address belongs to
+ required: false
+ type: string
+ - name: neutron-subnet-id
+ in: query
+ description: Neutron id of subnet that address belongs to
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing l3-interface-ipv4-address-list
+ description: |
+ Create or update an existing l3-interface-ipv4-address-list.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv4-address-list"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l3-interface-ipv4-address-list
+ description: |
+ Update an existing l3-interface-ipv4-address-list
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing l3-interface-ipv4-address-list
+ description: delete an existing l3-interface-ipv4-address-list
+ operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV4-ADDRESS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /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:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ /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:
+ tags:
+ - Network
+ summary: returns l3-interface-ipv6-address-list
+ description: returns l3-interface-ipv6-address-list
+ operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface that address belongs to
+ required: false
+ type: string
+ - name: neutron-subnet-id
+ in: query
+ description: Neutron id of subnet that address belongs to
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing l3-interface-ipv6-address-list
+ description: |
+ Create or update an existing l3-interface-ipv6-address-list.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l3-interface-ipv6-address-list
+ description: |
+ Update an existing l3-interface-ipv6-address-list
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: body
+ in: body
+ description: l3-interface-ipv6-address-list object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing l3-interface-ipv6-address-list
+ description: delete an existing l3-interface-ipv6-address-list
+ operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ example: __L3-INTERFACE-IPV6-ADDRESS__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
+ get:
+ tags:
+ - Network
+ summary: returns l-interface
+ description: returns l-interface
+ operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l-interface"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: macaddr
+ in: query
+ description: MAC address for the interface
+ required: false
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing l-interface
+ description: |
+ Create or update an existing l-interface.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
+ required: true
+ schema:
+ $ref: "#/definitions/l-interface"
+ patch:
+ tags:
+ - Network
+ summary: update an existing l-interface
+ description: |
+ Update an existing l-interface
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: l-interface object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/l-interface"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing l-interface
+ description: delete an existing l-interface
+ operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: interface-name
+ in: path
+ description: Name given to the interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
+ get:
+ tags:
+ - Network
+ summary: returns l-interfaces
+ description: returns l-interfaces
+ operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfaces
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/l-interfaces"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ required: false
+ type: string
+ /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}:
+ get:
+ tags:
+ - Network
+ summary: returns lag-interface
+ description: returns lag-interface
+ operationId: getNetworkPnfsPnfLagInterfacesLagInterface
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/lag-interface"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ - name: interface-id
+ in: query
+ description: ID of interface
+ required: false
+ type: string
+ - name: interface-role
+ in: query
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing lag-interface
+ description: |
+ Create or update an existing lag-interface.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterface.json)
+ required: true
+ schema:
+ $ref: "#/definitions/lag-interface"
+ patch:
+ tags:
+ - Network
+ summary: update an existing lag-interface
+ description: |
+ Update an existing lag-interface
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: body
+ in: body
+ description: lag-interface object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/lag-interface"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing lag-interface
+ description: delete an existing lag-interface
+ operationId: deleteNetworkPnfsPnfLagInterfacesLagInterface
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: interface-name
+ in: path
+ description: Name that identifies the link aggregate interface
+ required: true
+ type: string
+ example: __INTERFACE-NAME__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/pnfs/pnf/{pnf-name}/lag-interfaces:
+ get:
+ tags:
+ - Network
+ summary: returns lag-interfaces
+ description: returns lag-interfaces
+ operationId: getNetworkPnfsPnfLagInterfaces
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/lag-interfaces"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ /network/pnfs/pnf/{pnf-name}:
+ get:
+ tags:
+ - Network
+ summary: returns pnf
+ description: returns pnf
+ operationId: getNetworkPnfsPnf
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/pnf"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: inv-status
+ in: query
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing pnf
+ description: |
+ Create or update an existing pnf.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkPnfsPnf
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: body
+ in: body
+ description: pnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnf.json)
+ required: true
+ schema:
+ $ref: "#/definitions/pnf"
+ patch:
+ tags:
+ - Network
+ summary: update an existing pnf
+ description: |
+ Update an existing pnf
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkPnfsPnf
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: body
+ in: body
+ description: pnf object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/pnf"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing pnf
+ description: delete an existing pnf
+ operationId: deleteNetworkPnfsPnf
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: pnf-name
+ in: path
+ description: unique name of Physical Network Function.
+ required: true
+ type: string
+ example: __PNF-NAME__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/pnfs:
+ get:
+ tags:
+ - Network
+ summary: returns pnfs
+ description: returns pnfs
+ operationId: getNetworkPnfs
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/pnfs"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /network/physical-links/physical-link/{link-name}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: link-name
+ in: path
+ description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
+ required: true
+ type: string
+ example: __LINK-NAME__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPhysicalLinksPhysicalLink.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: link-name
+ in: path
+ description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
+ required: true
+ type: string
+ example: __LINK-NAME__
+ /network/physical-links/physical-link/{link-name}:
+ get:
+ tags:
+ - Network
+ summary: returns physical-link
+ description: returns physical-link
+ operationId: getNetworkPhysicalLinksPhysicalLink
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/physical-link"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: link-name
+ in: path
+ description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
+ required: true
+ type: string
+ example: __LINK-NAME__
+ - name: circuit-id
+ in: query
+ description: Circuit it
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing physical-link
+ description: |
+ Create or update an existing physical-link.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkPhysicalLinksPhysicalLink
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: link-name
+ in: path
+ description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
+ required: true
+ type: string
+ example: __LINK-NAME__
+ - name: body
+ in: body
+ description: physical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPhysicalLinksPhysicalLink.json)
+ required: true
+ schema:
+ $ref: "#/definitions/physical-link"
+ patch:
+ tags:
+ - Network
+ summary: update an existing physical-link
+ description: |
+ Update an existing physical-link
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkPhysicalLinksPhysicalLink
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: link-name
+ in: path
+ description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
+ required: true
+ type: string
+ example: __LINK-NAME__
+ - name: body
+ in: body
+ description: physical-link object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/physical-link"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing physical-link
+ description: delete an existing physical-link
+ operationId: deleteNetworkPhysicalLinksPhysicalLink
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: link-name
+ in: path
+ description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
+ required: true
+ type: string
+ example: __LINK-NAME__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/physical-links:
+ get:
+ tags:
+ - Network
+ summary: returns physical-links
+ description: returns physical-links
+ operationId: getNetworkPhysicalLinks
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/physical-links"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: ipsec-configuration-id
+ in: path
+ description: UUID of this configuration
+ required: true
+ type: string
+ example: __IPSEC-CONFIGURATION-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkIpsecConfigurationsIpsecConfiguration.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: ipsec-configuration-id
+ in: path
+ description: UUID of this configuration
+ required: true
+ type: string
+ example: __IPSEC-CONFIGURATION-ID__
+ /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: ipsec-configuration-id
+ in: path
+ description: UUID of this configuration
+ required: true
+ type: string
+ example: __IPSEC-CONFIGURATION-ID__
+ - name: vig-address-type
+ in: path
+ description: indicates whether the VIG is for AVPN or INTERNET
+ required: true
+ type: string
+ example: __VIG-ADDRESS-TYPE__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: ipsec-configuration-id
+ in: path
+ description: UUID of this configuration
+ required: true
+ type: string
+ example: __IPSEC-CONFIGURATION-ID__
+ - name: vig-address-type
+ in: path
+ description: indicates whether the VIG is for AVPN or INTERNET
+ required: true
+ type: string
+ example: __VIG-ADDRESS-TYPE__
+ /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}:
+ get:
+ tags:
+ - Network
+ summary: returns vig-server
+ description: returns vig-server
+ operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/vig-server"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: ipsec-configuration-id
+ in: path
+ description: UUID of this configuration
+ required: true
+ type: string
+ example: __IPSEC-CONFIGURATION-ID__
+ - name: vig-address-type
+ in: path
+ description: indicates whether the VIG is for AVPN or INTERNET
+ required: true
+ type: string
+ example: __VIG-ADDRESS-TYPE__
+ put:
+ tags:
+ - Network
+ summary: create or update an existing vig-server
+ description: |
+ Create or update an existing vig-server.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: ipsec-configuration-id
+ in: path
+ description: UUID of this configuration
+ required: true
+ type: string
+ example: __IPSEC-CONFIGURATION-ID__
+ - name: vig-address-type
+ in: path
+ description: indicates whether the VIG is for AVPN or INTERNET
+ required: true
+ type: string
+ example: __VIG-ADDRESS-TYPE__
+ - name: body
+ in: body
+ description: vig-server object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)
+ required: true
+ schema:
+ $ref: "#/definitions/vig-server"
+ patch:
+ tags:
+ - Network
+ summary: update an existing vig-server
+ description: |
+ Update an existing vig-server
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: ipsec-configuration-id
+ in: path
+ description: UUID of this configuration
+ required: true
+ type: string
+ example: __IPSEC-CONFIGURATION-ID__
+ - name: vig-address-type
+ in: path
+ description: indicates whether the VIG is for AVPN or INTERNET
+ required: true
+ type: string
+ example: __VIG-ADDRESS-TYPE__
+ - name: body
+ in: body
+ description: vig-server object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/vig-server"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing vig-server
+ description: delete an existing vig-server
+ operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: ipsec-configuration-id
+ in: path
+ description: UUID of this configuration
+ required: true
+ type: string
+ example: __IPSEC-CONFIGURATION-ID__
+ - name: vig-address-type
+ in: path
+ description: indicates whether the VIG is for AVPN or INTERNET
+ required: true
+ type: string
+ example: __VIG-ADDRESS-TYPE__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers:
+ get:
+ tags:
+ - Network
+ summary: returns vig-servers
+ description: returns vig-servers
+ operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServers
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/vig-servers"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: ipsec-configuration-id
+ in: path
+ description: UUID of this configuration
+ required: true
+ type: string
+ example: __IPSEC-CONFIGURATION-ID__
+ /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}:
+ get:
+ tags:
+ - Network
+ summary: returns ipsec-configuration
+ description: returns ipsec-configuration
+ operationId: getNetworkIpsecConfigurationsIpsecConfiguration
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/ipsec-configuration"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: ipsec-configuration-id
+ in: path
+ description: UUID of this configuration
+ required: true
+ type: string
+ example: __IPSEC-CONFIGURATION-ID__
+ put:
+ tags:
+ - Network
+ summary: create or update an existing ipsec-configuration
+ description: |
+ Create or update an existing ipsec-configuration.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfiguration
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: ipsec-configuration-id
+ in: path
+ description: UUID of this configuration
+ required: true
+ type: string
+ example: __IPSEC-CONFIGURATION-ID__
+ - name: body
+ in: body
+ description: ipsec-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkIpsecConfigurationsIpsecConfiguration.json)
+ required: true
+ schema:
+ $ref: "#/definitions/ipsec-configuration"
+ patch:
+ tags:
+ - Network
+ summary: update an existing ipsec-configuration
+ description: |
+ Update an existing ipsec-configuration
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkIpsecConfigurationsIpsecConfiguration
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: ipsec-configuration-id
+ in: path
+ description: UUID of this configuration
+ required: true
+ type: string
+ example: __IPSEC-CONFIGURATION-ID__
+ - name: body
+ in: body
+ description: ipsec-configuration object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/ipsec-configuration"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing ipsec-configuration
+ description: delete an existing ipsec-configuration
+ operationId: deleteNetworkIpsecConfigurationsIpsecConfiguration
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: ipsec-configuration-id
+ in: path
+ description: UUID of this configuration
+ required: true
+ type: string
+ example: __IPSEC-CONFIGURATION-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/ipsec-configurations:
+ get:
+ tags:
+ - Network
+ summary: returns ipsec-configurations
+ description: returns ipsec-configurations
+ operationId: getNetworkIpsecConfigurations
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/ipsec-configurations"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: route-table-reference-id
+ in: path
+ description: Route Table Reference id, UUID assigned to this instance.
+ required: true
+ type: string
+ example: __ROUTE-TABLE-REFERENCE-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkRouteTableReferencesRouteTableReference.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: route-table-reference-id
+ in: path
+ description: Route Table Reference id, UUID assigned to this instance.
+ required: true
+ type: string
+ example: __ROUTE-TABLE-REFERENCE-ID__
+ /network/route-table-references/route-table-reference/{route-table-reference-id}:
+ get:
+ tags:
+ - Network
+ summary: returns route-table-reference
+ description: returns route-table-reference
+ operationId: getNetworkRouteTableReferencesRouteTableReference
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/route-table-reference"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: route-table-reference-id
+ in: path
+ description: Route Table Reference id, UUID assigned to this instance.
+ required: true
+ type: string
+ example: __ROUTE-TABLE-REFERENCE-ID__
+ - name: route-table-reference-fqdn
+ in: query
+ description: FQDN entry in the route table.
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing route-table-reference
+ description: |
+ Create or update an existing route-table-reference.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReference
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: route-table-reference-id
+ in: path
+ description: Route Table Reference id, UUID assigned to this instance.
+ required: true
+ type: string
+ example: __ROUTE-TABLE-REFERENCE-ID__
+ - name: body
+ in: body
+ description: route-table-reference object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkRouteTableReferencesRouteTableReference.json)
+ required: true
+ schema:
+ $ref: "#/definitions/route-table-reference"
+ patch:
+ tags:
+ - Network
+ summary: update an existing route-table-reference
+ description: |
+ Update an existing route-table-reference
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkRouteTableReferencesRouteTableReference
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: route-table-reference-id
+ in: path
+ description: Route Table Reference id, UUID assigned to this instance.
+ required: true
+ type: string
+ example: __ROUTE-TABLE-REFERENCE-ID__
+ - name: body
+ in: body
+ description: route-table-reference object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/route-table-reference"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing route-table-reference
+ description: delete an existing route-table-reference
+ operationId: deleteNetworkRouteTableReferencesRouteTableReference
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: route-table-reference-id
+ in: path
+ description: Route Table Reference id, UUID assigned to this instance.
+ required: true
+ type: string
+ example: __ROUTE-TABLE-REFERENCE-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/route-table-references:
+ get:
+ tags:
+ - Network
+ summary: returns route-table-references
+ description: returns route-table-references
+ operationId: getNetworkRouteTableReferences
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/route-table-references"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /network/instance-groups/instance-group/{id}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkInstanceGroupsInstanceGroupRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: id
+ in: path
+ description: Instance Group ID, UUID assigned to this instance.
+ required: true
+ type: string
+ example: __ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkInstanceGroupsInstanceGroup.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkInstanceGroupsInstanceGroupRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: id
+ in: path
+ description: Instance Group ID, UUID assigned to this instance.
+ required: true
+ type: string
+ example: __ID__
+ /network/instance-groups/instance-group/{id}:
+ get:
+ tags:
+ - Network
+ summary: returns instance-group
+ description: returns instance-group
+ operationId: getNetworkInstanceGroupsInstanceGroup
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/instance-group"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: id
+ in: path
+ description: Instance Group ID, UUID assigned to this instance.
+ required: true
+ type: string
+ example: __ID__
+ - name: description
+ in: query
+ description: Descriptive text to help identify the usage of this instance-group
+ required: false
+ type: string
+ - name: type
+ in: query
+ description: Only valid value today is lower case ha for high availability
+ required: false
+ type: string
+ - name: sub-type
+ in: query
+ description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing instance-group
+ description: |
+ Create or update an existing instance-group.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkInstanceGroupsInstanceGroup
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: id
+ in: path
+ description: Instance Group ID, UUID assigned to this instance.
+ required: true
+ type: string
+ example: __ID__
+ - name: body
+ in: body
+ description: instance-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkInstanceGroupsInstanceGroup.json)
+ required: true
+ schema:
+ $ref: "#/definitions/instance-group"
+ patch:
+ tags:
+ - Network
+ summary: update an existing instance-group
+ description: |
+ Update an existing instance-group
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkInstanceGroupsInstanceGroup
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: id
+ in: path
+ description: Instance Group ID, UUID assigned to this instance.
+ required: true
+ type: string
+ example: __ID__
+ - name: body
+ in: body
+ description: instance-group object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/instance-group"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing instance-group
+ description: delete an existing instance-group
+ operationId: deleteNetworkInstanceGroupsInstanceGroup
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: id
+ in: path
+ description: Instance Group ID, UUID assigned to this instance.
+ required: true
+ type: string
+ example: __ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/instance-groups:
+ get:
+ tags:
+ - Network
+ summary: returns instance-groups
+ description: returns instance-groups
+ operationId: getNetworkInstanceGroups
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/instance-groups"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /network/zones/zone/{zone-id}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkZonesZoneRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: zone-id
+ in: path
+ description: Code assigned by AIC to the zone
+ required: true
+ type: string
+ example: __ZONE-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkZonesZone.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkZonesZoneRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: zone-id
+ in: path
+ description: Code assigned by AIC to the zone
+ required: true
+ type: string
+ example: __ZONE-ID__
+ /network/zones/zone/{zone-id}:
+ get:
+ tags:
+ - Network
+ summary: returns zone
+ description: returns zone
+ operationId: getNetworkZonesZone
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/zone"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: zone-id
+ in: path
+ description: Code assigned by AIC to the zone
+ required: true
+ type: string
+ example: __ZONE-ID__
+ - name: design-type
+ in: query
+ description: Design of zone [Medium/Largeā€¦]
+ required: false
+ type: string
+ - name: zone-context
+ in: query
+ description: Context of zone [production/test]
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing zone
+ description: |
+ Create or update an existing zone.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkZonesZone
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: zone-id
+ in: path
+ description: Code assigned by AIC to the zone
+ required: true
+ type: string
+ example: __ZONE-ID__
+ - name: body
+ in: body
+ description: zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkZonesZone.json)
+ required: true
+ schema:
+ $ref: "#/definitions/zone"
+ patch:
+ tags:
+ - Network
+ summary: update an existing zone
+ description: |
+ Update an existing zone
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkZonesZone
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: zone-id
+ in: path
+ description: Code assigned by AIC to the zone
+ required: true
+ type: string
+ example: __ZONE-ID__
+ - name: body
+ in: body
+ description: zone object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/zone"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing zone
+ description: delete an existing zone
+ operationId: deleteNetworkZonesZone
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: zone-id
+ in: path
+ description: Code assigned by AIC to the zone
+ required: true
+ type: string
+ example: __ZONE-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/zones:
+ get:
+ tags:
+ - Network
+ summary: returns zones
+ description: returns zones
+ operationId: getNetworkZones
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/zones"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /network/configurations/configuration/{configuration-id}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkConfigurationsConfigurationRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: configuration-id
+ in: path
+ description: UUID assigned to configuration.
+ required: true
+ type: string
+ example: __CONFIGURATION-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfiguration.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkConfigurationsConfigurationRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: configuration-id
+ in: path
+ description: UUID assigned to configuration.
+ required: true
+ type: string
+ example: __CONFIGURATION-ID__
+ /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}:
+ get:
+ tags:
+ - Network
+ summary: returns metadatum
+ description: returns metadatum
+ operationId: getNetworkConfigurationsConfigurationMetadataMetadatum
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/metadatum"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: configuration-id
+ in: path
+ description: UUID assigned to configuration.
+ required: true
+ type: string
+ example: __CONFIGURATION-ID__
+ - name: metaname
+ in: path
+ required: true
+ type: string
+ example: __METANAME__
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing metadatum
+ description: |
+ Create or update an existing metadatum.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkConfigurationsConfigurationMetadataMetadatum
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: configuration-id
+ in: path
+ description: UUID assigned to configuration.
+ required: true
+ type: string
+ example: __CONFIGURATION-ID__
+ - name: metaname
+ in: path
+ required: true
+ type: string
+ example: __METANAME__
+ - name: body
+ in: body
+ description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfigurationMetadataMetadatum.json)
+ required: true
+ schema:
+ $ref: "#/definitions/metadatum"
+ patch:
+ tags:
+ - Network
+ summary: update an existing metadatum
+ description: |
+ Update an existing metadatum
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkConfigurationsConfigurationMetadataMetadatum
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: configuration-id
+ in: path
+ description: UUID assigned to configuration.
+ required: true
+ type: string
+ example: __CONFIGURATION-ID__
+ - name: metaname
+ in: path
+ required: true
+ type: string
+ example: __METANAME__
+ - name: body
+ in: body
+ description: metadatum object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/metadatum"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing metadatum
+ description: delete an existing metadatum
+ operationId: deleteNetworkConfigurationsConfigurationMetadataMetadatum
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: configuration-id
+ in: path
+ description: UUID assigned to configuration.
+ required: true
+ type: string
+ example: __CONFIGURATION-ID__
+ - name: metaname
+ in: path
+ required: true
+ type: string
+ example: __METANAME__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/configurations/configuration/{configuration-id}/metadata:
+ get:
+ tags:
+ - Network
+ summary: returns metadata
+ description: returns metadata
+ operationId: getNetworkConfigurationsConfigurationMetadata
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/metadata"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: configuration-id
+ in: path
+ description: UUID assigned to configuration.
+ required: true
+ type: string
+ example: __CONFIGURATION-ID__
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: configuration-id
+ in: path
+ description: UUID assigned to configuration.
+ required: true
+ type: string
+ example: __CONFIGURATION-ID__
+ - name: forwarder-evc-id
+ in: path
+ description: Key for forwarder-evc object
+ required: true
+ type: string
+ example: __FORWARDER-EVC-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfigurationForwarderEvcsForwarderEvc.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: configuration-id
+ in: path
+ description: UUID assigned to configuration.
+ required: true
+ type: string
+ example: __CONFIGURATION-ID__
+ - name: forwarder-evc-id
+ in: path
+ description: Key for forwarder-evc object
+ required: true
+ type: string
+ example: __FORWARDER-EVC-ID__
+ /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}:
+ get:
+ tags:
+ - Network
+ summary: returns forwarder-evc
+ description: returns forwarder-evc
+ operationId: getNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/forwarder-evc"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: configuration-id
+ in: path
+ description: UUID assigned to configuration.
+ required: true
+ type: string
+ example: __CONFIGURATION-ID__
+ - name: forwarder-evc-id
+ in: path
+ description: Key for forwarder-evc object
+ required: true
+ type: string
+ example: __FORWARDER-EVC-ID__
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing forwarder-evc
+ description: |
+ Create or update an existing forwarder-evc.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: configuration-id
+ in: path
+ description: UUID assigned to configuration.
+ required: true
+ type: string
+ example: __CONFIGURATION-ID__
+ - name: forwarder-evc-id
+ in: path
+ description: Key for forwarder-evc object
+ required: true
+ type: string
+ example: __FORWARDER-EVC-ID__
+ - name: body
+ in: body
+ description: forwarder-evc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfigurationForwarderEvcsForwarderEvc.json)
+ required: true
+ schema:
+ $ref: "#/definitions/forwarder-evc"
+ patch:
+ tags:
+ - Network
+ summary: update an existing forwarder-evc
+ description: |
+ Update an existing forwarder-evc
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: configuration-id
+ in: path
+ description: UUID assigned to configuration.
+ required: true
+ type: string
+ example: __CONFIGURATION-ID__
+ - name: forwarder-evc-id
+ in: path
+ description: Key for forwarder-evc object
+ required: true
+ type: string
+ example: __FORWARDER-EVC-ID__
+ - name: body
+ in: body
+ description: forwarder-evc object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/forwarder-evc"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing forwarder-evc
+ description: delete an existing forwarder-evc
+ operationId: deleteNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: configuration-id
+ in: path
+ description: UUID assigned to configuration.
+ required: true
+ type: string
+ example: __CONFIGURATION-ID__
+ - name: forwarder-evc-id
+ in: path
+ description: Key for forwarder-evc object
+ required: true
+ type: string
+ example: __FORWARDER-EVC-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/configurations/configuration/{configuration-id}/forwarder-evcs:
+ get:
+ tags:
+ - Network
+ summary: returns forwarder-evcs
+ description: returns forwarder-evcs
+ operationId: getNetworkConfigurationsConfigurationForwarderEvcs
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/forwarder-evcs"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: configuration-id
+ in: path
+ description: UUID assigned to configuration.
+ required: true
+ type: string
+ example: __CONFIGURATION-ID__
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkConfigurationsConfigurationEvcsEvcRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: configuration-id
+ in: path
+ description: UUID assigned to configuration.
+ required: true
+ type: string
+ example: __CONFIGURATION-ID__
+ - name: evc-id
+ in: path
+ description: Unique/key field for the evc object
+ required: true
+ type: string
+ example: __EVC-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfigurationEvcsEvc.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkConfigurationsConfigurationEvcsEvcRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: configuration-id
+ in: path
+ description: UUID assigned to configuration.
+ required: true
+ type: string
+ example: __CONFIGURATION-ID__
+ - name: evc-id
+ in: path
+ description: Unique/key field for the evc object
+ required: true
+ type: string
+ example: __EVC-ID__
+ /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}:
+ get:
+ tags:
+ - Network
+ summary: returns evc
+ description: returns evc
+ operationId: getNetworkConfigurationsConfigurationEvcsEvc
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/evc"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: configuration-id
+ in: path
+ description: UUID assigned to configuration.
+ required: true
+ type: string
+ example: __CONFIGURATION-ID__
+ - name: evc-id
+ in: path
+ description: Unique/key field for the evc object
+ required: true
+ type: string
+ example: __EVC-ID__
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing evc
+ description: |
+ Create or update an existing evc.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkConfigurationsConfigurationEvcsEvc
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: configuration-id
+ in: path
+ description: UUID assigned to configuration.
+ required: true
+ type: string
+ example: __CONFIGURATION-ID__
+ - name: evc-id
+ in: path
+ description: Unique/key field for the evc object
+ required: true
+ type: string
+ example: __EVC-ID__
+ - name: body
+ in: body
+ description: evc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfigurationEvcsEvc.json)
+ required: true
+ schema:
+ $ref: "#/definitions/evc"
+ patch:
+ tags:
+ - Network
+ summary: update an existing evc
+ description: |
+ Update an existing evc
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkConfigurationsConfigurationEvcsEvc
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: configuration-id
+ in: path
+ description: UUID assigned to configuration.
+ required: true
+ type: string
+ example: __CONFIGURATION-ID__
+ - name: evc-id
+ in: path
+ description: Unique/key field for the evc object
+ required: true
+ type: string
+ example: __EVC-ID__
+ - name: body
+ in: body
+ description: evc object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/evc"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing evc
+ description: delete an existing evc
+ operationId: deleteNetworkConfigurationsConfigurationEvcsEvc
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: configuration-id
+ in: path
+ description: UUID assigned to configuration.
+ required: true
+ type: string
+ example: __CONFIGURATION-ID__
+ - name: evc-id
+ in: path
+ description: Unique/key field for the evc object
+ required: true
+ type: string
+ example: __EVC-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/configurations/configuration/{configuration-id}/evcs:
+ get:
+ tags:
+ - Network
+ summary: returns evcs
+ description: returns evcs
+ operationId: getNetworkConfigurationsConfigurationEvcs
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/evcs"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: configuration-id
+ in: path
+ description: UUID assigned to configuration.
+ required: true
+ type: string
+ example: __CONFIGURATION-ID__
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ /network/configurations/configuration/{configuration-id}:
+ get:
+ tags:
+ - Network
+ summary: returns configuration
+ description: returns configuration
+ operationId: getNetworkConfigurationsConfiguration
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/configuration"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: configuration-id
+ in: path
+ description: UUID assigned to configuration.
+ required: true
+ type: string
+ example: __CONFIGURATION-ID__
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing configuration
+ description: |
+ Create or update an existing configuration.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkConfigurationsConfiguration
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: configuration-id
+ in: path
+ description: UUID assigned to configuration.
+ required: true
+ type: string
+ example: __CONFIGURATION-ID__
+ - name: body
+ in: body
+ description: configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfiguration.json)
+ required: true
+ schema:
+ $ref: "#/definitions/configuration"
+ patch:
+ tags:
+ - Network
+ summary: update an existing configuration
+ description: |
+ Update an existing configuration
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkConfigurationsConfiguration
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: configuration-id
+ in: path
+ description: UUID assigned to configuration.
+ required: true
+ type: string
+ example: __CONFIGURATION-ID__
+ - name: body
+ in: body
+ description: configuration object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/configuration"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing configuration
+ description: delete an existing configuration
+ operationId: deleteNetworkConfigurationsConfiguration
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: configuration-id
+ in: path
+ description: UUID assigned to configuration.
+ required: true
+ type: string
+ example: __CONFIGURATION-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/configurations:
+ get:
+ tags:
+ - Network
+ summary: returns configurations
+ description: returns configurations
+ operationId: getNetworkConfigurations
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/configurations"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /network/forwarding-paths/forwarding-path/{forwarding-path-id}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkForwardingPathsForwardingPathRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: forwarding-path-id
+ in: path
+ description: Unique ID of this FP
+ required: true
+ type: string
+ example: __FORWARDING-PATH-ID__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkForwardingPathsForwardingPath.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkForwardingPathsForwardingPathRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: forwarding-path-id
+ in: path
+ description: Unique ID of this FP
+ required: true
+ type: string
+ example: __FORWARDING-PATH-ID__
+ /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkForwardingPathsForwardingPathForwardersForwarderRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: forwarding-path-id
+ in: path
+ description: Unique ID of this FP
+ required: true
+ type: string
+ example: __FORWARDING-PATH-ID__
+ - name: sequence
+ in: path
+ description: Unique ID of this segmentation
+ required: true
+ type: integer
+ format: int32
+ example: __SEQUENCE__
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkForwardingPathsForwardingPathForwardersForwarder.json)
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkForwardingPathsForwardingPathForwardersForwarderRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: forwarding-path-id
+ in: path
+ description: Unique ID of this FP
+ required: true
+ type: string
+ example: __FORWARDING-PATH-ID__
+ - name: sequence
+ in: path
+ description: Unique ID of this segmentation
+ required: true
+ type: integer
+ format: int32
+ example: __SEQUENCE__
+ /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}:
+ get:
+ tags:
+ - Network
+ summary: returns forwarder
+ description: returns forwarder
+ operationId: getNetworkForwardingPathsForwardingPathForwardersForwarder
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/forwarder"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: forwarding-path-id
+ in: path
+ description: Unique ID of this FP
+ required: true
+ type: string
+ example: __FORWARDING-PATH-ID__
+ - name: sequence
+ in: path
+ description: Unique ID of this segmentation
+ required: true
+ type: integer
+ format: int32
+ example: __SEQUENCE__
+ - name: forwarding-path-name
+ in: query
+ description: Name of the FP
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing forwarder
+ description: |
+ Create or update an existing forwarder.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkForwardingPathsForwardingPathForwardersForwarder
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: forwarding-path-id
+ in: path
+ description: Unique ID of this FP
+ required: true
+ type: string
+ example: __FORWARDING-PATH-ID__
+ - name: sequence
+ in: path
+ description: Unique ID of this segmentation
+ required: true
+ type: integer
+ format: int32
+ example: __SEQUENCE__
+ - name: body
+ in: body
+ description: forwarder object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkForwardingPathsForwardingPathForwardersForwarder.json)
+ required: true
+ schema:
+ $ref: "#/definitions/forwarder"
+ patch:
+ tags:
+ - Network
+ summary: update an existing forwarder
+ description: |
+ Update an existing forwarder
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkForwardingPathsForwardingPathForwardersForwarder
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: forwarding-path-id
+ in: path
+ description: Unique ID of this FP
+ required: true
+ type: string
+ example: __FORWARDING-PATH-ID__
+ - name: sequence
+ in: path
+ description: Unique ID of this segmentation
+ required: true
+ type: integer
+ format: int32
+ example: __SEQUENCE__
+ - name: body
+ in: body
+ description: forwarder object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/forwarder"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing forwarder
+ description: delete an existing forwarder
+ operationId: deleteNetworkForwardingPathsForwardingPathForwardersForwarder
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: forwarding-path-id
+ in: path
+ description: Unique ID of this FP
+ required: true
+ type: string
+ example: __FORWARDING-PATH-ID__
+ - name: sequence
+ in: path
+ description: Unique ID of this segmentation
+ required: true
+ type: integer
+ format: int32
+ example: __SEQUENCE__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders:
+ get:
+ tags:
+ - Network
+ summary: returns forwarders
+ description: returns forwarders
+ operationId: getNetworkForwardingPathsForwardingPathForwarders
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/forwarders"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: forwarding-path-id
+ in: path
+ description: Unique ID of this FP
+ required: true
+ type: string
+ example: __FORWARDING-PATH-ID__
+ - name: forwarding-path-name
+ in: query
+ description: Name of the FP
+ required: false
+ type: string
+ /network/forwarding-paths/forwarding-path/{forwarding-path-id}:
+ get:
+ tags:
+ - Network
+ summary: returns forwarding-path
+ description: returns forwarding-path
+ operationId: getNetworkForwardingPathsForwardingPath
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/forwarding-path"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: forwarding-path-id
+ in: path
+ description: Unique ID of this FP
+ required: true
+ type: string
+ example: __FORWARDING-PATH-ID__
+ - name: forwarding-path-name
+ in: query
+ description: Name of the FP
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing forwarding-path
+ description: |
+ Create or update an existing forwarding-path.
+ #
+ Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
+ operationId: createOrUpdateNetworkForwardingPathsForwardingPath
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: forwarding-path-id
+ in: path
+ description: Unique ID of this FP
+ required: true
+ type: string
+ example: __FORWARDING-PATH-ID__
+ - name: body
+ in: body
+ description: forwarding-path object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkForwardingPathsForwardingPath.json)
+ required: true
+ schema:
+ $ref: "#/definitions/forwarding-path"
+ patch:
+ tags:
+ - Network
+ summary: update an existing forwarding-path
+ description: |
+ Update an existing forwarding-path
+ #
+ Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
+ The PUT operation will entirely replace an existing object.
+ The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
+ #
+ Other differences between PUT and PATCH are:
+ #
+ - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
+ - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
+ - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
+ operationId: UpdateNetworkForwardingPathsForwardingPath
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: forwarding-path-id
+ in: path
+ description: Unique ID of this FP
+ required: true
+ type: string
+ example: __FORWARDING-PATH-ID__
+ - name: body
+ in: body
+ description: forwarding-path object that needs to be created or updated.
+ required: true
+ schema:
+ $ref: "#/patchDefinitions/forwarding-path"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing forwarding-path
+ description: delete an existing forwarding-path
+ operationId: deleteNetworkForwardingPathsForwardingPath
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: forwarding-path-id
+ in: path
+ description: Unique ID of this FP
+ required: true
+ type: string
+ example: __FORWARDING-PATH-ID__
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/forwarding-paths:
+ get:
+ tags:
+ - Network
+ summary: returns forwarding-paths
+ description: returns forwarding-paths
+ operationId: getNetworkForwardingPaths
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/getDefinitions/forwarding-paths"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+definitions:
+ aai-internal:
+ properties:
+ property-name:
+ type: string
+ property-value:
+ type: string
+ action:
+ properties:
+ action-type:
+ type: string
+ action-data:
+ type: array
+ items:
+ $ref: "#/definitions/action-data"
+ action-data:
+ properties:
+ property-name:
+ type: string
+ property-value:
+ type: string
+ actions:
+ description: |
+ APIs that are more action related than REST (e.g., notify, update).
+ properties:
+ update:
+ type: object
+ $ref: "#/definitions/update"
+ notify:
+ type: object
+ $ref: "#/definitions/notify"
+ allotted-resource:
+ description: |
+ Represents a slice or partial piece of a resource that gets separately allotted
+ ###### Related Nodes
+ - TO allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE)
+ - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
+ - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
+ - TO l-interface( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY)
+ - TO network-policy( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
+ - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
+ - TO vpn-binding( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY)
+ - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
+ - TO model-ver( allotted-resource org.onap.relationships.inventory.IsA model-ver, Many2One)
+ - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
+ - FROM configuration( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
+ - FROM allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE)
+ - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT
+ required:
+ - id
+ properties:
+ id:
+ type: string
+ description: Allotted Resource id UUID assigned to this instance.
+ description:
+ type: string
+ description: The descriptive information assigned to this allotted resource instance
+ selflink:
+ type: string
+ description: Link back to more information in the controller
+ model-invariant-id:
+ type: string
+ description: the ASDC model id for this resource or service model.
+ model-version-id:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ persona-model-version:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ resource-version:
+ type: string
+ description: Concurrency value
+ orchestration-status:
+ type: string
+ description: Orchestration status
+ operational-status:
+ type: string
+ description: Indicator for whether the resource is considered operational
+ type:
+ type: string
+ description: Generic description of the type of allotted resource.
+ role:
+ type: string
+ description: role in the network that this resource will be providing.
+ tunnel-xconnects:
+ type: array
+ items:
+ $ref: "#/definitions/tunnel-xconnect"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ allotted-resources:
+ description: |
+ This object is used to store slices of services being offered
+ properties:
+ allotted-resource:
+ type: array
+ items:
+ $ref: "#/definitions/allotted-resource"
+ availability-zone:
+ description: |
+ Availability zone, a collection of compute hosts/pservers
+ ###### Related Nodes
+ - TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
+ - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
+ - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
+ - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
+ - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
+ - AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
+ required:
+ - availability-zone-name
+ - hypervisor-type
+ properties:
+ availability-zone-name:
+ type: string
+ description: Name of the availability zone. Unique across a cloud region
+ hypervisor-type:
+ type: string
+ description: Type of hypervisor. Source of truth should define valid values.
+ operational-status:
+ type: string
+ description: State that indicates whether the availability zone should be used, etc. Source of truth should define valid values.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ availability-zones:
+ description: |
+ Collection of availability zones
+ properties:
+ availability-zone:
+ type: array
+ items:
+ $ref: "#/definitions/availability-zone"
+ az-and-dvs-switches:
+ properties:
+ dvs-switches:
+ type: object
+ $ref: "#/definitions/dvs-switches"
+ availability-zone:
+ type: object
+ $ref: "#/definitions/availability-zone"
+ business:
+ description: |
+ Namespace for business related constructs
+ properties:
+ connectors:
+ type: array
+ items:
+ $ref: "#/definitions/connector"
+ customers:
+ type: array
+ items:
+ $ref: "#/definitions/customer"
+ lines-of-business:
+ type: array
+ items:
+ $ref: "#/definitions/line-of-business"
+ owning-entities:
+ type: array
+ items:
+ $ref: "#/definitions/owning-entity"
+ platforms:
+ type: array
+ items:
+ $ref: "#/definitions/platform"
+ projects:
+ type: array
+ items:
+ $ref: "#/definitions/project"
+ class-of-service:
+ description: |
+ ###### Related Nodes
+ - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
+ required:
+ - cos
+ properties:
+ cos:
+ type: string
+ description: unique identifier of probe
+ probe-id:
+ type: string
+ description: identifier of probe
+ probe-type:
+ type: string
+ description: type of probe
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ classes-of-service:
+ description: |
+ class-of-service of probe
+ properties:
+ class-of-service:
+ type: array
+ items:
+ $ref: "#/definitions/class-of-service"
+ cloud-infrastructure:
+ description: |
+ Namespace for cloud infrastructure.
+ properties:
+ complexes:
+ type: array
+ items:
+ $ref: "#/definitions/complex"
+ cloud-regions:
+ type: array
+ items:
+ $ref: "#/definitions/cloud-region"
+ network-profiles:
+ type: array
+ items:
+ $ref: "#/definitions/network-profile"
+ pservers:
+ type: array
+ items:
+ $ref: "#/definitions/pserver"
+ virtual-data-centers:
+ type: array
+ items:
+ $ref: "#/definitions/virtual-data-center"
+ operational-environments:
+ type: array
+ items:
+ $ref: "#/definitions/operational-environment"
+ cloud-region:
+ description: |
+ cloud-region designates an installation of a cloud cluster or region or instantiation.
+ ###### Related Nodes
+ - TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many)
+ - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
+ - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
+ - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
+ - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
+ - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
+ - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE
+ - CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
+ required:
+ - cloud-owner
+ - cloud-region-id
+ - sriov-automation
+ properties:
+ cloud-owner:
+ type: string
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ cloud-region-id:
+ type: string
+ description: Identifier used by the vendor for the region. Second part of composite key
+ cloud-type:
+ type: string
+ description: Type of the cloud (e.g., openstack)
+ owner-defined-type:
+ type: string
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ cloud-region-version:
+ type: string
+ description: Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
+ identity-url:
+ type: string
+ description: URL of the keystone identity service
+ cloud-zone:
+ type: string
+ description: Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
+ complex-name:
+ type: string
+ description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
+ sriov-automation:
+ type: boolean
+ cloud-extra-info:
+ type: string
+ description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
+ cloud-epa-caps:
+ type: string
+ description: MultiVIM will discover and expose EPA capabilities.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ volume-groups:
+ type: array
+ items:
+ $ref: "#/definitions/volume-group"
+ tenants:
+ type: array
+ items:
+ $ref: "#/definitions/tenant"
+ flavors:
+ type: array
+ items:
+ $ref: "#/definitions/flavor"
+ group-assignments:
+ type: array
+ items:
+ $ref: "#/definitions/group-assignment"
+ snapshots:
+ type: array
+ items:
+ $ref: "#/definitions/snapshot"
+ images:
+ type: array
+ items:
+ $ref: "#/definitions/image"
+ dvs-switches:
+ type: array
+ items:
+ $ref: "#/definitions/dvs-switch"
+ oam-networks:
+ type: array
+ items:
+ $ref: "#/definitions/oam-network"
+ availability-zones:
+ type: array
+ items:
+ $ref: "#/definitions/availability-zone"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ vip-ipv4-address-list:
+ type: array
+ items:
+ $ref: "#/definitions/vip-ipv4-address-list"
+ vip-ipv6-address-list:
+ type: array
+ items:
+ $ref: "#/definitions/vip-ipv6-address-list"
+ cloud-regions:
+ properties:
+ cloud-region:
+ type: array
+ items:
+ $ref: "#/definitions/cloud-region"
+ complex:
+ description: |
+ Collection of physical locations that can house cloud-regions.
+ ###### Related Nodes
+ - TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
+ - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
+ - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
+ - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
+ - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
+ - COMPLEX is DELETED when these are DELETED CTAG-POOL
+ required:
+ - physical-location-id
+ - physical-location-type
+ - street1
+ - city
+ - postal-code
+ - country
+ - region
+ properties:
+ physical-location-id:
+ type: string
+ description: Unique identifier for physical location, e.g., CLLI
+ data-center-code:
+ type: string
+ description: Data center code which can be an alternate way to identify a complex
+ complex-name:
+ type: string
+ description: Gamma complex name for LCP instance.
+ identity-url:
+ type: string
+ description: URL of the keystone identity service
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ physical-location-type:
+ type: string
+ description: Type, e.g., central office, data center.
+ street1:
+ type: string
+ street2:
+ type: string
+ city:
+ type: string
+ state:
+ type: string
+ postal-code:
+ type: string
+ country:
+ type: string
+ region:
+ type: string
+ latitude:
+ type: string
+ longitude:
+ type: string
+ elevation:
+ type: string
+ lata:
+ type: string
+ ctag-pools:
+ type: array
+ items:
+ $ref: "#/definitions/ctag-pool"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ complexes:
+ description: |
+ Collection of physical locations that can house cloud-regions.
+ properties:
+ complex:
+ type: array
+ items:
+ $ref: "#/definitions/complex"
+ configuration:
+ description: |
+ Port Mirror Configuration.
+ ###### Related Nodes
+ - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
+ - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
+ - TO l-interface( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY)
+ - TO pnf( configuration org.onap.relationships.inventory.AppliesTo pnf, ONE2MANY)
+ - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
+ - FROM forwarder( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
+ - FROM forwarding-path( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
+ - FROM evc( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
+ - FROM forwarder-evc( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
+ - CONFIGURATION is DELETED when these are DELETED METADATUM,EVC,FORWARDER-EVC
+ - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK
+ required:
+ - configuration-id
+ - configuration-type
+ - configuration-sub-type
+ - orchestration-status
+ - operational-status
+ - configuration-selflink
+ - model-customization-id
+ properties:
+ configuration-id:
+ type: string
+ description: UUID assigned to configuration.
+ management-option:
+ type: string
+ description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
+ configuration-name:
+ type: string
+ description: Name of the configuration.
+ configuration-type:
+ type: string
+ description: port-mirroring-configuration.
+ configuration-sub-type:
+ type: string
+ description: vprobe, pprobe.
+ model-invariant-id:
+ type: string
+ description: the ASDC model id for this resource or service model.
+ model-version-id:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ orchestration-status:
+ type: string
+ description: Orchestration status of the configuration.
+ operational-status:
+ type: string
+ description: Indicator for whether the resource is considered operational.
+ configuration-selflink:
+ type: string
+ description: URL to endpoint where AAI can get more details from SDN-GC.
+ model-customization-id:
+ type: string
+ description: id of the configuration used to customize the resource
+ tunnel-bandwidth:
+ type: string
+ description: DHV Site Effective Bandwidth
+ vendor-allowed-max-bandwidth:
+ type: string
+ description: Velocloud Nominal Throughput - VNT
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ metadata:
+ type: array
+ items:
+ $ref: "#/definitions/metadatum"
+ forwarder-evcs:
+ type: array
+ items:
+ $ref: "#/definitions/forwarder-evc"
+ evcs:
+ type: array
+ items:
+ $ref: "#/definitions/evc"
+ configurations:
+ description: |
+ Collection of configurations
+ properties:
+ configuration:
+ type: array
+ items:
+ $ref: "#/definitions/configuration"
+ connector:
+ description: |
+ Collection of resource instances used to connect a variety of disparate inventory widgets
+ ###### Related Nodes
+ - TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
+ - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
+ - CONNECTOR is DELETED when these are DELETED METADATUM
+ required:
+ - resource-instance-id
+ properties:
+ resource-instance-id:
+ type: string
+ description: Unique id of resource instance.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ model-invariant-id:
+ type: string
+ description: the ASDC model id for this resource or service model.
+ model-version-id:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ persona-model-version:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ widget-model-id:
+ type: string
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ widget-model-version:
+ type: string
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ metadata:
+ type: array
+ items:
+ $ref: "#/definitions/metadatum"
+ connectors:
+ description: |
+ Collection of resource instances used to connect a variety of disparate inventory widgets
+ properties:
+ connector:
+ type: array
+ items:
+ $ref: "#/definitions/connector"
+ constrained-element-set:
+ description: |
+ This is how we would capture constraints defining allowed sets of elements.
+ ###### Related Nodes
+ - TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
+ - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
+ - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
+ - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET
+ required:
+ - constrained-element-set-uuid
+ - constraint-type
+ - check-type
+ properties:
+ constrained-element-set-uuid:
+ type: string
+ constraint-type:
+ type: string
+ check-type:
+ type: string
+ resource-version:
+ type: string
+ element-choice-sets:
+ type: array
+ items:
+ $ref: "#/definitions/element-choice-set"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ constrained-element-sets:
+ properties:
+ constrained-element-set:
+ type: array
+ items:
+ $ref: "#/definitions/constrained-element-set"
+ ctag-assignment:
+ description: |
+ ###### Related Nodes
+ - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
+ required:
+ - vlan-id-inner
+ properties:
+ vlan-id-inner:
+ type: integer
+ format: int64
+ description: id.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ ctag-assignments:
+ properties:
+ ctag-assignment:
+ type: array
+ items:
+ $ref: "#/definitions/ctag-assignment"
+ ctag-pool:
+ description: |
+ A collection of C tags (vlan tags) grouped for a specific purpose.
+ ###### Related Nodes
+ - TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
+ - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
+ - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
+ required:
+ - target-pe
+ - availability-zone-name
+ - ctag-pool-purpose
+ properties:
+ target-pe:
+ type: string
+ description: The Target provider edge router
+ availability-zone-name:
+ type: string
+ description: Name of the availability zone
+ ctag-pool-purpose:
+ type: string
+ description: Describes what the intended purpose of this pool is.
+ ctag-values:
+ type: string
+ description: Comma separated list of ctags
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ ctag-pools:
+ properties:
+ ctag-pool:
+ type: array
+ items:
+ $ref: "#/definitions/ctag-pool"
+ customer:
+ description: |
+ customer identifiers to provide linkage back to BSS information.
+ ###### Related Nodes
+ - FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
+ - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION
+ required:
+ - global-customer-id
+ - subscriber-name
+ - subscriber-type
+ properties:
+ global-customer-id:
+ type: string
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ subscriber-name:
+ type: string
+ description: Subscriber name, an alternate way to retrieve a customer.
+ subscriber-type:
+ type: string
+ description: Subscriber type, a way to provide VID with only the INFRA customers.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ service-subscriptions:
+ type: array
+ items:
+ $ref: "#/definitions/service-subscription"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ customers:
+ description: |
+ Collection of customer identifiers to provide linkage back to BSS information.
+ properties:
+ customer:
+ type: array
+ items:
+ $ref: "#/definitions/customer"
+ cvlan-tag-entry:
+ required:
+ - cvlan-tag
+ properties:
+ cvlan-tag:
+ type: integer
+ format: int64
+ description: See mis-na-virtualization-platform.yang
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ cvlan-tags:
+ properties:
+ cvlan-tag-entry:
+ type: array
+ items:
+ $ref: "#/definitions/cvlan-tag-entry"
+ dvs-switch:
+ 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.
+ ###### Related Nodes
+ - TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
+ required:
+ - switch-name
+ - vcenter-url
+ properties:
+ switch-name:
+ type: string
+ description: DVS switch name
+ vcenter-url:
+ type: string
+ description: URL used to reach the vcenter
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ dvs-switches:
+ description: |
+ Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
+ properties:
+ dvs-switch:
+ type: array
+ items:
+ $ref: "#/definitions/dvs-switch"
+ edge-prop-names:
+ description: |
+ Internal map to define the properties of an edge and interpret the map EdgeRules
+ properties:
+ edgeLabel:
+ type: string
+ direction:
+ type: string
+ multiplicityRule:
+ type: string
+ contains-other-v:
+ type: string
+ delete-other-v:
+ type: string
+ SVC-INFRA:
+ type: string
+ prevent-delete:
+ type: string
+ aai-uuid:
+ type: string
+ edge-tag-query-request:
+ properties:
+ edge-tag:
+ type: string
+ result-detail:
+ type: string
+ start-node-type:
+ type: string
+ start-node-filter:
+ type: array
+ items:
+ $ref: "#/definitions/start-node-filter"
+ include-node-filter:
+ type: array
+ items:
+ $ref: "#/definitions/include-node-filter"
+ secondary-filter:
+ type: array
+ items:
+ $ref: "#/definitions/secondary-filter"
+ edge-tag-query-result:
+ properties:
+ tagged-inventory-item-list:
+ type: array
+ items:
+ $ref: "#/definitions/tagged-inventory-item-list"
+ element-choice-set:
+ description: |
+ This is how we would capture constraints defining allowed sets of elements.
+ ###### Related Nodes
+ - TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
+ - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
+ - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT
+ required:
+ - element-choice-set-uuid
+ - element-choice-set-name
+ properties:
+ element-choice-set-uuid:
+ type: string
+ element-choice-set-name:
+ type: string
+ cardinality:
+ type: string
+ resource-version:
+ type: string
+ model-elements:
+ type: array
+ items:
+ $ref: "#/definitions/model-element"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ element-choice-sets:
+ properties:
+ element-choice-set:
+ type: array
+ items:
+ $ref: "#/definitions/element-choice-set"
+ entitlement:
+ description: |
+ Metadata for entitlement group.
+ ###### Related Nodes
+ - TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
+ required:
+ - group-uuid
+ - resource-uuid
+ properties:
+ group-uuid:
+ type: string
+ description: Unique ID for the entitlement group the resource comes from, should be uuid.
+ resource-uuid:
+ type: string
+ description: Unique ID of an entitlement resource.
+ resource-version:
+ type: string
+ description: Concurrency value
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ entitlements:
+ description: |
+ Entitlements, keyed by group-uuid and resource-uuid, related to license management
+ properties:
+ entitlement:
+ type: array
+ items:
+ $ref: "#/definitions/entitlement"
+ esr-ems:
+ description: |
+ Persist EMS address information used by EMS driver.
+ ###### Related Nodes
+ - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)
+ - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
+ required:
+ - ems-id
+ properties:
+ ems-id:
+ type: string
+ description: Unique ID of EMS.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ esr-system-info-list:
+ type: object
+ $ref: "#/definitions/esr-system-info-list"
+ relationship-list:
+ type: object
+ $ref: "#/definitions/relationship-list"
+ esr-ems-list:
+ properties:
+ esr-ems:
+ type: array
+ items:
+ $ref: "#/definitions/esr-ems"
+ esr-system-info:
+ description: |
+ Persist common address information of external systems.
+ ###### Related Nodes
+ - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)
+ - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)
+ - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)
+ - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)
+ required:
+ - esr-system-info-id
+ - user-name
+ - password
+ - system-type
+ properties:
+ esr-system-info-id:
+ type: string
+ description: Unique ID of esr system info.
+ system-name:
+ type: string
+ description: name of external system.
+ type:
+ type: string
+ description: type of external systems.
+ vendor:
+ type: string
+ description: vendor of external systems.
+ version:
+ type: string
+ description: version of external systems.
+ service-url:
+ type: string
+ description: url used to access external systems.
+ user-name:
+ type: string
+ description: username used to access external systems.
+ password:
+ type: string
+ description: password used to access external systems.
+ system-type:
+ type: string
+ description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
+ protocol:
+ type: string
+ description: protocol of third party SDNC, for example netconf/snmp.
+ ssl-cacert:
+ type: string
+ description: ca file content if enabled ssl on auth-url.
+ ssl-insecure:
+ type: boolean
+ description: Whether to verify VIM's certificate.
+ ip-address:
+ type: string
+ description: service IP of ftp server.
+ port:
+ type: string
+ description: service port of ftp server.
+ cloud-domain:
+ type: string
+ description: domain info for authentication.
+ default-tenant:
+ type: string
+ description: default tenant of VIM.
+ passive:
+ type: boolean
+ description: ftp passive mode or not.
+ remote-path:
+ type: string
+ description: resource or performance data file path.
+ system-status:
+ type: string
+ description: the status of external system.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: object
+ $ref: "#/definitions/relationship-list"
+ esr-system-info-list:
+ description: |
+ Collection of persistent block-level external system auth info.
+ properties:
+ esr-system-info:
+ type: array
+ items:
+ $ref: "#/definitions/esr-system-info"
+ esr-thirdparty-sdnc:
+ description: |
+ Persist SDNC address information used by ONAP SDNC.
+ ###### Related Nodes
+ - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)
+ - TO pnf( esr-thirdparty-sdnc has pnf, One2Many)
+ - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
+ required:
+ - thirdparty-sdnc-id
+ properties:
+ thirdparty-sdnc-id:
+ type: string
+ description: Unique ID of SDNC.
+ location:
+ type: string
+ description: used for DC type to indicate the location of SDNC, such as Core or Edge.
+ product-name:
+ type: string
+ description: password used to access SDNC server.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ esr-system-info-list:
+ type: object
+ $ref: "#/definitions/esr-system-info-list"
+ relationship-list:
+ type: object
+ $ref: "#/definitions/relationship-list"
+ esr-thirdparty-sdnc-list:
+ properties:
+ esr-thirdparty-sdnc:
+ type: array
+ items:
+ $ref: "#/definitions/esr-thirdparty-sdnc"
+ esr-vnfm:
+ description: |
+ Persist VNFM address information used by VF-C.
+ ###### Related Nodes
+ - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)
+ - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
+ required:
+ - vnfm-id
+ properties:
+ vnfm-id:
+ type: string
+ description: Unique ID of VNFM.
+ vim-id:
+ type: string
+ description: indecate the VIM to deploy VNF.
+ certificate-url:
+ type: string
+ description: certificate url of VNFM.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ esr-system-info-list:
+ type: object
+ $ref: "#/definitions/esr-system-info-list"
+ relationship-list:
+ type: object
+ $ref: "#/definitions/relationship-list"
+ esr-vnfm-list:
+ properties:
+ esr-vnfm:
+ type: array
+ items:
+ $ref: "#/definitions/esr-vnfm"
+ evc:
+ description: |
+ evc object is an optional child object of the Configuration object.
+ ###### Related Nodes
+ - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
+ required:
+ - evc-id
+ properties:
+ evc-id:
+ type: string
+ description: Unique/key field for the evc object
+ forwarding-path-topology:
+ type: string
+ description: Point-to-Point, Multi-Point
+ cir-value:
+ type: string
+ description: Commited Information Rate
+ cir-units:
+ type: string
+ description: CIR units
+ connection-diversity-group-id:
+ type: string
+ description: Diversity Group ID
+ service-hours:
+ type: string
+ description: formerly Performance Group
+ esp-evc-circuit-id:
+ type: string
+ description: EVC Circuit ID of ESP EVC
+ esp-evc-cir-value:
+ type: string
+ description: Committed Information Rate (For ESP)
+ esp-evc-cir-units:
+ type: string
+ description: CIR units (For ESP)
+ esp-itu-code:
+ type: string
+ description: Identifies ESP
+ collector-pop-clli:
+ type: string
+ description: Collector POP CLLI (from the hostname of the access pnf)
+ inter-connect-type-ingress:
+ type: string
+ description: Interconnect type on ingress side of EVC.
+ tagmode-access-ingress:
+ type: string
+ description: tagode for collector side of EVC
+ tagmode-access-egress:
+ type: string
+ description: tagMode for network side of EVC
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ evcs:
+ properties:
+ evc:
+ type: array
+ items:
+ $ref: "#/definitions/evc"
+ external-system:
+ description: |
+ Namespace for external system.
+ properties:
+ esr-ems-list:
+ type: object
+ $ref: "#/definitions/esr-ems-list"
+ esr-vnfm-list:
+ type: object
+ $ref: "#/definitions/esr-vnfm-list"
+ esr-thirdparty-sdnc-list:
+ type: object
+ $ref: "#/definitions/esr-thirdparty-sdnc-list"
+ extra-properties:
+ description: |
+ Extra properties for inventory item for response list
+ properties:
+ extra-property:
+ type: array
+ items:
+ $ref: "#/definitions/extra-property"
+ extra-property:
+ properties:
+ property-name:
+ type: string
+ property-value:
+ type: string
+ flavor:
+ description: |
+ Openstack flavor.
+ ###### Related Nodes
+ - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
+ - FLAVOR cannot be deleted if linked to VSERVER
+ required:
+ - flavor-id
+ - flavor-name
+ - flavor-selflink
+ properties:
+ flavor-id:
+ type: string
+ description: Flavor id, expected to be unique across cloud-region.
+ flavor-name:
+ type: string
+ description: Flavor name
+ flavor-vcpus:
+ type: integer
+ format: int32
+ description: Number of CPUs
+ flavor-ram:
+ type: integer
+ format: int32
+ description: Amount of memory
+ flavor-disk:
+ type: integer
+ format: int32
+ description: Disk space
+ flavor-ephemeral:
+ type: integer
+ format: int32
+ description: Amount of ephemeral disk space
+ flavor-swap:
+ type: string
+ description: amount of swap space allocation
+ flavor-is-public:
+ type: boolean
+ description: whether flavor is available to all users or private to the tenant it was created in.
+ flavor-selflink:
+ type: string
+ description: URL to endpoint where AAI can get more details
+ flavor-disabled:
+ type: boolean
+ description: Boolean as to whether this flavor is no longer enabled
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ flavors:
+ description: |
+ Collection of openstack flavors.
+ properties:
+ flavor:
+ type: array
+ items:
+ $ref: "#/definitions/flavor"
+ forwarder:
+ description: |
+ Entity describing a sequenced segment of forwarding path
+ ###### Related Nodes
+ - TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
+ - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
+ - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
+ - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
+ - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
+ - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION
+ required:
+ - sequence
+ properties:
+ sequence:
+ type: integer
+ format: int32
+ description: Unique ID of this segmentation
+ forwarder-role:
+ type: string
+ description: ingress, intermediate, egress
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ forwarder-evc:
+ description: |
+ forwarder object is an optional child object of the Configuration object.
+ ###### Related Nodes
+ - TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
+ required:
+ - forwarder-evc-id
+ properties:
+ forwarder-evc-id:
+ type: string
+ description: Key for forwarder-evc object
+ circuit-id:
+ type: string
+ description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
+ ivlan:
+ type: string
+ description: Internal VLAN.
+ svlan:
+ type: string
+ description: SVLAN value for ingress of egress forwarder.
+ cvlan:
+ type: string
+ description: CVLAN value for ingress of egress forwarder.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ forwarder-evcs:
+ properties:
+ forwarder-evc:
+ type: array
+ items:
+ $ref: "#/definitions/forwarder-evc"
+ forwarders:
+ properties:
+ forwarder:
+ type: array
+ items:
+ $ref: "#/definitions/forwarder"
+ forwarding-path:
+ description: |
+ Entity that describes the sequenced forwarding path between interfaces of services or resources
+ ###### Related Nodes
+ - TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
+ - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
+ - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
+ - FORWARDING-PATH is DELETED when these are DELETED FORWARDER
+ - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION
+ required:
+ - forwarding-path-id
+ - forwarding-path-name
+ properties:
+ forwarding-path-id:
+ type: string
+ description: Unique ID of this FP
+ forwarding-path-name:
+ type: string
+ description: Name of the FP
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ selflink:
+ type: string
+ description: the self link for this FP
+ forwarders:
+ type: array
+ items:
+ $ref: "#/definitions/forwarder"
+ forwarding-paths:
+ properties:
+ forwarding-path:
+ type: array
+ items:
+ $ref: "#/definitions/forwarding-path"
+ generic-vnf:
+ description: |
+ General purpose VNF
+ ###### Related Nodes
+ - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
+ - TO complex( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
+ - TO configuration( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
+ - TO ctag-pool( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
+ - TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
+ - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
+ - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY)
+ - TO pnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY)
+ - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
+ - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
+ - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
+ - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
+ - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
+ - TO model-ver( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One)
+ - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
+ - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
+ - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
+ - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - FROM line-of-business( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
+ - FROM platform( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
+ - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE
+ - GENERIC-VNF deletion means associated objects of these types are also DELETED:CONFIGURATION
+ required:
+ - vnf-id
+ - vnf-instance-id
+ - vnf-name
+ - vnf-type
+ - vnf-package-name
+ - vnf-discriptor-name
+ - job-id
+ - in-maint
+ - is-closed-loop-disabled
+ properties:
+ vnf-id:
+ type: string
+ description: Unique id of VNF. This is unique across the graph.
+ vnf-instance-id:
+ type: string
+ description: vnf instance id.
+ vnf-name:
+ type: string
+ description: Name of VNF.
+ vnf-name2:
+ type: string
+ description: Alternate name of VNF.
+ vnf-type:
+ type: string
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ service-id:
+ type: string
+ description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
+ regional-resource-zone:
+ type: string
+ description: Regional way of organizing pservers, source of truth should define values
+ prov-status:
+ type: string
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ operational-status:
+ type: string
+ description: Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.
+ license-key:
+ type: string
+ description: OBSOLETE - do not use
+ equipment-role:
+ type: string
+ description: Client should send valid enumerated value
+ orchestration-status:
+ type: string
+ description: Orchestration status of this VNF, used by MSO.
+ vnf-package-name:
+ type: string
+ vnf-discriptor-name:
+ type: string
+ description: vnf discriptor name
+ job-id:
+ type: string
+ description: job id corresponding to vnf
+ heat-stack-id:
+ type: string
+ description: Heat stack id corresponding to this instance, managed by MSO
+ mso-catalog-key:
+ type: string
+ description: Corresponds to the SDN-C catalog id used to configure this VCE
+ management-option:
+ type: string
+ description: identifier of managed by ATT or customer
+ ipv4-oam-address:
+ type: string
+ description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
+ ipv4-loopback0-address:
+ type: string
+ description: v4 Loopback0 address
+ nm-lan-v6-address:
+ type: string
+ description: v6 Loopback address
+ management-v6-address:
+ type: string
+ description: v6 management address
+ vcpu:
+ type: integer
+ format: int64
+ description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
+ vcpu-units:
+ type: string
+ description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE
+ vmemory:
+ type: integer
+ format: int64
+ description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
+ vmemory-units:
+ type: string
+ description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE
+ vdisk:
+ type: integer
+ format: int64
+ description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE
+ vdisk-units:
+ type: string
+ description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE
+ nshd:
+ type: integer
+ format: int64
+ description: number of associated SHD in vnf.
+ nvm:
+ type: integer
+ format: int64
+ description: number of vms in vnf.
+ nnet:
+ type: integer
+ format: int64
+ description: number of network in vnf.
+ in-maint:
+ type: boolean
+ is-closed-loop-disabled:
+ type: boolean
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ summary-status:
+ type: string
+ description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.
+ encrypted-access-flag:
+ type: boolean
+ description: indicates whether generic-vnf access uses SSH
+ entitlement-assignment-group-uuid:
+ type: string
+ description: UUID of the Entitlement group used for licensing VNFs, OBSOLETE - See child relationships.
+ entitlement-resource-uuid:
+ type: string
+ description: UUID of the specific entitlement resource. OBSOLETE - See child relationships.
+ license-assignment-group-uuid:
+ type: string
+ description: UUID of the license assignment group. OBSOLETE - See child relationships.
+ license-key-uuid:
+ type: string
+ description: UUID of the actual license resource. OBSOLETE - See child relationships.
+ model-invariant-id:
+ type: string
+ description: the ASDC model id for this resource or service model.
+ model-version-id:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ persona-model-version:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ model-customization-id:
+ type: string
+ description: captures the id of all the configuration used to customize the resource for the service.
+ widget-model-id:
+ type: string
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ widget-model-version:
+ type: string
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ as-number:
+ type: string
+ description: as-number of the VNF
+ regional-resource-subzone:
+ type: string
+ description: represents sub zone of the rr plane
+ nf-type:
+ type: string
+ description: Generic description of the type of NF
+ nf-function:
+ type: string
+ description: English description of Network function that the specific VNF deployment is providing
+ nf-role:
+ type: string
+ description: role in the network that this model will be providing
+ nf-naming-code:
+ type: string
+ description: string assigned to this model used for naming purposes
+ selflink:
+ type: string
+ description: Path to the controller object.
+ ipv4-oam-gateway-address:
+ type: string
+ description: Gateway address
+ ipv4-oam-gateway-address-prefix-length:
+ type: integer
+ format: int32
+ description: Prefix length for oam-address
+ vlan-id-outer:
+ type: integer
+ format: int64
+ description: Temporary location for S-TAG to get to VCE
+ nm-profile-name:
+ type: string
+ description: Network Management profile of this VNF
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ l-interfaces:
+ type: array
+ items:
+ $ref: "#/definitions/l-interface"
+ lag-interfaces:
+ type: array
+ items:
+ $ref: "#/definitions/lag-interface"
+ vf-modules:
+ type: array
+ items:
+ $ref: "#/definitions/vf-module"
+ licenses:
+ type: array
+ items:
+ $ref: "#/definitions/license"
+ entitlements:
+ type: array
+ items:
+ $ref: "#/definitions/entitlement"
+ generic-vnfs:
+ description: |
+ Collection of VNFs
+ properties:
+ generic-vnf:
+ type: array
+ items:
+ $ref: "#/definitions/generic-vnf"
+ group-assignment:
+ description: |
+ Openstack group-assignment used to store exclusivity groups (EG).
+ ###### Related Nodes
+ - TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
+ - FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
+ required:
+ - group-id
+ - group-type
+ - group-name
+ properties:
+ group-id:
+ type: string
+ description: Group id, expected to be unique across cloud-region.
+ group-type:
+ type: string
+ description: Group type - the type of group this instance refers to
+ group-name:
+ type: string
+ description: Group name - name assigned to the group
+ group-description:
+ type: string
+ description: Group description - description of the group
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ group-assignments:
+ description: |
+ Collection of openstack group assignments
+ properties:
+ group-assignment:
+ type: array
+ items:
+ $ref: "#/definitions/group-assignment"
+ host-route:
+ description: |
+ ###### Related Nodes
+ - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
+ required:
+ - host-route-id
+ - route-prefix
+ - next-hop
+ properties:
+ host-route-id:
+ type: string
+ description: host-route id
+ route-prefix:
+ type: string
+ description: subnet prefix
+ next-hop:
+ type: string
+ description: Could be ip-address, hostname, or service-instance
+ next-hop-type:
+ type: string
+ description: Should be ip-address, hostname, or service-instance to match next-hop
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ host-routes:
+ properties:
+ host-route:
+ type: array
+ items:
+ $ref: "#/definitions/host-route"
+ image:
+ description: |
+ Openstack image.
+ ###### Related Nodes
+ - TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
+ - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
+ - IMAGE cannot be deleted if linked to VSERVER
+ - IMAGE is DELETED when these are DELETED METADATUM
+ required:
+ - image-id
+ - image-name
+ - image-os-distro
+ - image-os-version
+ - image-selflink
+ properties:
+ image-id:
+ type: string
+ description: Image id, expected to be unique across cloud region
+ image-name:
+ type: string
+ description: Image name
+ image-architecture:
+ type: string
+ description: Operating system architecture.
+ image-os-distro:
+ type: string
+ description: The common name of the operating system distribution in lowercase
+ image-os-version:
+ type: string
+ description: The operating system version as specified by the distributor.
+ application:
+ type: string
+ description: The application that the image instantiates.
+ application-vendor:
+ type: string
+ description: The vendor of the application.
+ application-version:
+ type: string
+ description: The version of the application.
+ image-selflink:
+ type: string
+ description: URL to endpoint where AAI can get more details
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ metadata:
+ type: array
+ items:
+ $ref: "#/definitions/metadatum"
+ images:
+ description: |
+ Collectio of Openstack images.
+ properties:
+ image:
+ type: array
+ items:
+ $ref: "#/definitions/image"
+ include-node-filter:
+ properties:
+ include-node-type:
+ type: string
+ instance-filter:
+ description: |
+ InstanceFilter for performing a named-query or model query
+ instance-filters:
+ description: |
+ InstanceFilters for performing a named-query or model query
+ properties:
+ instance-filter:
+ type: array
+ items:
+ $ref: "#/definitions/instance-filter"
+ instance-group:
+ description: |
+ General mechanism for grouping instances
+ ###### Related Nodes
+ - TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
+ - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
+ - FROM l3-network( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - FROM l-interface( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - FROM vnfc( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ required:
+ - instance-group-role
+ - model-invariant-id
+ - model-version-id
+ - id
+ - description
+ - type
+ properties:
+ instance-group-role:
+ type: string
+ description: role of the instance group.
+ model-invariant-id:
+ type: string
+ description: ASDC model id for this resource or service model.
+ model-version-id:
+ type: string
+ description: ASDC model version uid for this resource model.
+ id:
+ type: string
+ description: Instance Group ID, UUID assigned to this instance.
+ description:
+ type: string
+ description: Descriptive text to help identify the usage of this instance-group
+ type:
+ type: string
+ description: Only valid value today is lower case ha for high availability
+ sub-type:
+ type: string
+ description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
+ resource-version:
+ type: string
+ description: Concurrency value
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ instance-groups:
+ description: |
+ Collection of openstack route table references
+ properties:
+ instance-group:
+ type: array
+ items:
+ $ref: "#/definitions/instance-group"
+ inventory:
+ properties:
+ search:
+ type: object
+ $ref: "#/definitions/search"
+ actions:
+ type: object
+ $ref: "#/definitions/actions"
+ cloud-infrastructure:
+ type: object
+ $ref: "#/definitions/cloud-infrastructure"
+ external-system:
+ type: object
+ $ref: "#/definitions/external-system"
+ business:
+ type: object
+ $ref: "#/definitions/business"
+ service-design-and-creation:
+ type: object
+ $ref: "#/definitions/service-design-and-creation"
+ network:
+ type: object
+ $ref: "#/definitions/network"
+ aai-internal:
+ type: object
+ $ref: "#/definitions/aai-internal"
+ nodes:
+ type: array
+ items:
+ $ref: "#/definitions/aai-internal"
+ inventory-item:
+ properties:
+ inventory-item-type:
+ type: string
+ inventory-item-link:
+ type: string
+ inventory-item-data:
+ type: array
+ items:
+ $ref: "#/definitions/inventory-item-data"
+ tagged-inventory-item-list:
+ type: array
+ items:
+ $ref: "#/definitions/tagged-inventory-item-list"
+ inventory-item-data:
+ properties:
+ property-name:
+ type: string
+ property-value:
+ type: string
+ inventory-response-item:
+ description: |
+ Inventory item for response list
+ properties:
+ model-name:
+ type: string
+ extra-properties:
+ type: object
+ $ref: "#/definitions/extra-properties"
+ inventory-response-items:
+ type: object
+ $ref: "#/definitions/inventory-response-items"
+ inventory-response-items:
+ description: |
+ Container for inventory items in response list
+ properties:
+ inventory-response-item:
+ type: array
+ items:
+ $ref: "#/definitions/inventory-response-item"
+ ipsec-configuration:
+ 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
+ ###### Related Nodes
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
+ - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
+ - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER
+ required:
+ - ipsec-configuration-id
+ properties:
+ ipsec-configuration-id:
+ type: string
+ description: UUID of this configuration
+ requested-vig-address-type:
+ type: string
+ description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
+ requested-encryption-strength:
+ type: string
+ description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
+ requested-dmz-type:
+ type: string
+ description: ATT can offer a shared DMZ or a DMZ specific to a customer
+ shared-dmz-network-address:
+ type: string
+ description: Network address of shared DMZ
+ requested-customer-name:
+ type: string
+ description: If the DMZ is a custom DMZ, this field will indicate the customer information
+ ike-version:
+ type: string
+ description: can be 1 or 2
+ ikev1-authentication:
+ type: string
+ description: Contains values like md5, sha1, sha256, sha384
+ ikev1-encryption:
+ type: string
+ description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,ƂĀ aes-192-cbc, aes-265-cbc
+ ikev1-dh-group:
+ type: string
+ description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
+ ikev1-am-group-id:
+ type: string
+ description: Group name defined in VIG for clients using aggressive mode
+ ikev1-am-password:
+ type: string
+ description: pre-shared key for the above group name
+ ikev1-sa-lifetime:
+ type: string
+ description: Lifetime for IKEv1 SA
+ ipsec-authentication:
+ type: string
+ description: md5, sha1, sha256, sha384
+ ipsec-encryption:
+ type: string
+ description: 3des-cbc, des-cbc, aes-128-cbc,ƂĀ aes-192-cbc, aes-265-cbc
+ ipsec-sa-lifetime:
+ type: string
+ description: Life time for IPSec SA
+ ipsec-pfs:
+ type: string
+ description: enable PFS or not
+ xauth-userid:
+ type: string
+ description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName
+ xauth-user-password:
+ type: string
+ description: Encrypted using the Juniper $9$ algorithm
+ dpd-interval:
+ type: string
+ description: The time between DPD probe
+ dpd-frequency:
+ type: string
+ description: Maximum number of DPD before claiming the tunnel is down
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ vig-servers:
+ type: array
+ items:
+ $ref: "#/definitions/vig-server"
+ ipsec-configurations:
+ properties:
+ ipsec-configuration:
+ type: array
+ items:
+ $ref: "#/definitions/ipsec-configuration"
+ key-data:
+ properties:
+ key-name:
+ type: string
+ key-value:
+ type: string
+ l-interface:
+ description: |
+ Logical interfaces, e.g., a vnic.
+ ###### Related Nodes
+ - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
+ - TO instance-group( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
+ - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
+ - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
+ - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
+ - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
+ - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY)
+ - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
+ - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
+ - FROM configuration( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY)
+ - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
+ - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
+ - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,LOGICAL-LINK,SRIOV-VF,VLAN
+ - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
+ required:
+ - interface-name
+ - is-port-mirrored
+ - in-maint
+ - is-ip-unnumbered
+ properties:
+ interface-name:
+ type: string
+ description: Name given to the interface
+ interface-role:
+ type: string
+ description: E.g., CUSTOMER, UPLINK, etc.
+ v6-wan-link-ip:
+ type: string
+ description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
+ selflink:
+ type: string
+ description: URL to endpoint where AAI can get more details
+ interface-id:
+ type: string
+ description: ID of interface
+ macaddr:
+ type: string
+ description: MAC address for the interface
+ network-name:
+ type: string
+ description: Name of the network
+ management-option:
+ type: string
+ description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
+ interface-description:
+ type: string
+ description: Human friendly text regarding this interface.
+ is-port-mirrored:
+ type: boolean
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ in-maint:
+ type: boolean
+ prov-status:
+ type: string
+ description: Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV].
+ is-ip-unnumbered:
+ type: boolean
+ allowed-address-pairs:
+ type: string
+ description: Freeform field for storing an ip address, list of ip addresses or a subnet block.
+ vlans:
+ type: array
+ items:
+ $ref: "#/definitions/vlan"
+ sriov-vfs:
+ type: array
+ items:
+ $ref: "#/definitions/sriov-vf"
+ l-interfaces:
+ type: array
+ items:
+ $ref: "#/definitions/l-interface"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ l3-interface-ipv4-address-list:
+ type: array
+ items:
+ $ref: "#/definitions/l3-interface-ipv4-address-list"
+ l3-interface-ipv6-address-list:
+ type: array
+ items:
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
+ l-interfaces:
+ description: |
+ Collection of logical interfaces.
+ properties:
+ l-interface:
+ type: array
+ items:
+ $ref: "#/definitions/l-interface"
+ l3-interface-ipv4-address-list:
+ description: |
+ IPv4 Address Range
+ ###### Related Nodes
+ - TO instance-group( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
+ - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
+ - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
+ - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
+ - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
+ - TO vnfc( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
+ required:
+ - l3-interface-ipv4-address
+ properties:
+ l3-interface-ipv4-address:
+ type: string
+ description: IP address
+ l3-interface-ipv4-prefix-length:
+ type: integer
+ format: int64
+ description: Prefix length, 32 for single address
+ vlan-id-inner:
+ type: integer
+ format: int64
+ description: Inner VLAN tag
+ vlan-id-outer:
+ type: integer
+ format: int64
+ description: Outer VLAN tag
+ is-floating:
+ type: boolean
+ description: Indicator of fixed or floating address
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ neutron-network-id:
+ type: string
+ description: Neutron network id of the interface that address belongs to
+ neutron-subnet-id:
+ type: string
+ description: Neutron id of subnet that address belongs to
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ l3-interface-ipv6-address-list:
+ description: |
+ IPv6 Address Range
+ ###### Related Nodes
+ - TO instance-group( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
+ - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
+ - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
+ - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
+ - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
+ - TO vnfc( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
+ required:
+ - l3-interface-ipv6-address
+ properties:
+ l3-interface-ipv6-address:
+ type: string
+ description: IP address
+ l3-interface-ipv6-prefix-length:
+ type: integer
+ format: int64
+ description: Prefix length, 128 for single address
+ vlan-id-inner:
+ type: integer
+ format: int64
+ description: Inner VLAN tag
+ vlan-id-outer:
+ type: integer
+ format: int64
+ description: Outer VLAN tag
+ is-floating:
+ type: boolean
+ description: Indicator of fixed or floating address
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ neutron-network-id:
+ type: string
+ description: Neutron network id of the interface that address belongs to
+ neutron-subnet-id:
+ type: string
+ description: Neutron id of subnet that address belongs to
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ l3-network:
+ description: |
+ Generic network definition
+ ###### Related Nodes
+ - TO instance-group( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
+ - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
+ - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
+ - TO model-ver( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One)
+ - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
+ - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
+ - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
+ - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
+ - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
+ - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
+ - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
+ - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
+ - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET
+ required:
+ - network-id
+ - network-name
+ - is-bound-to-vpn
+ - is-provider-network
+ - is-shared-network
+ - is-external-network
+ properties:
+ network-id:
+ type: string
+ description: Network ID, should be uuid. Unique across A&AI.
+ network-name:
+ type: string
+ description: Name of the network, governed by some naming convention..
+ network-type:
+ type: string
+ description: Type of the network - who defines these values?
+ network-role:
+ type: string
+ description: Role the network plans - who defines these values?
+ network-technology:
+ type: string
+ description: Network technology - who defines these values?
+ neutron-network-id:
+ type: string
+ description: Neutron network id of this Interface
+ is-bound-to-vpn:
+ type: boolean
+ service-id:
+ type: string
+ description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
+ network-role-instance:
+ type: integer
+ format: int64
+ description: network role instance
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ orchestration-status:
+ type: string
+ description: Orchestration status of this VNF, mastered by MSO
+ heat-stack-id:
+ type: string
+ description: Heat stack id corresponding to this instance, managed by MSO
+ mso-catalog-key:
+ type: string
+ description: Corresponds to the SDN-C catalog id used to configure this VCE
+ contrail-network-fqdn:
+ type: string
+ description: Contrail FQDN for the network
+ model-invariant-id:
+ type: string
+ description: the ASDC model id for this resource or service model.
+ model-version-id:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ persona-model-version:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ model-customization-id:
+ type: string
+ description: captures the id of all the configuration used to customize the resource for the service.
+ widget-model-id:
+ type: string
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ widget-model-version:
+ type: string
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ physical-network-name:
+ type: string
+ description: Name associated with the physical network.
+ is-provider-network:
+ type: boolean
+ is-shared-network:
+ type: boolean
+ is-external-network:
+ type: boolean
+ selflink:
+ type: string
+ description: Path to the controller object.
+ operational-status:
+ type: string
+ description: Indicator for whether the resource is considered operational.
+ subnets:
+ type: array
+ items:
+ $ref: "#/definitions/subnet"
+ ctag-assignments:
+ type: array
+ items:
+ $ref: "#/definitions/ctag-assignment"
+ segmentation-assignments:
+ type: array
+ items:
+ $ref: "#/definitions/segmentation-assignment"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
+ l3-networks:
+ properties:
+ l3-network:
+ type: array
+ items:
+ $ref: "#/definitions/l3-network"
+ lag-interface:
+ description: |
+ Link aggregate interface
+ ###### Related Nodes
+ - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
+ - TO logical-link( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
+ - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
+ - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
+ - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
+ - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
+ - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
+ - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
+ - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE
+ - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK
+ required:
+ - interface-name
+ - in-maint
+ properties:
+ interface-name:
+ type: string
+ description: Name that identifies the link aggregate interface
+ interface-description:
+ type: string
+ description: Human friendly text regarding this interface.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ speed-value:
+ type: string
+ description: Captures the numeric part of the speed
+ speed-units:
+ type: string
+ description: Captures the units corresponding to the speed
+ interface-id:
+ type: string
+ description: ID of interface
+ interface-role:
+ type: string
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ prov-status:
+ type: string
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ in-maint:
+ type: boolean
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ l-interfaces:
+ type: array
+ items:
+ $ref: "#/definitions/l-interface"
+ lag-interfaces:
+ description: |
+ Collection of link aggregate interfaces.
+ properties:
+ lag-interface:
+ type: array
+ items:
+ $ref: "#/definitions/lag-interface"
+ lag-link:
+ description: |
+ LAG links can connect lag-interfaces
+ ###### Related Nodes
+ - FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
+ required:
+ - link-name
+ properties:
+ link-name:
+ type: string
+ description: Alphabetical concatenation of lag-interface names
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ lag-links:
+ description: |
+ Collection of link aggregation connections
+ properties:
+ lag-link:
+ type: array
+ items:
+ $ref: "#/definitions/lag-link"
+ license:
+ description: |
+ Metadata for license group.
+ ###### Related Nodes
+ - TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
+ required:
+ - group-uuid
+ - resource-uuid
+ properties:
+ group-uuid:
+ type: string
+ description: Unique ID for the license group the resource belongs to, should be uuid.
+ resource-uuid:
+ type: string
+ description: Unique ID of a license resource.
+ resource-version:
+ type: string
+ description: Concurrency value
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ licenses:
+ description: |
+ Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
+ properties:
+ license:
+ type: array
+ items:
+ $ref: "#/definitions/license"
+ line-of-business:
+ description: |
+ describes a line-of-business
+ ###### Related Nodes
+ - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
+ required:
+ - line-of-business-name
+ properties:
+ line-of-business-name:
+ type: string
+ description: Name of the line-of-business (product)
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ lines-of-business:
+ description: |
+ Collection of lines-of-business
+ properties:
+ line-of-business:
+ type: array
+ items:
+ $ref: "#/definitions/line-of-business"
+ logical-link:
+ description: |
+ Logical links generally connect l-interfaces but are used to express logical connectivity between two points
+ ###### Related Nodes
+ - TO l-interface( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY)
+ - TO l-interface( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY)
+ - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
+ - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
+ - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
+ - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
+ - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
+ - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
+ - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
+ - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
+ - TO model-ver( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One)
+ - FROM configuration( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
+ - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
+ - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
+ - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
+ - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
+ required:
+ - link-name
+ - in-maint
+ - link-type
+ properties:
+ link-name:
+ type: string
+ description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
+ in-maint:
+ type: boolean
+ link-type:
+ type: string
+ description: Type of logical link, e.g., evc
+ speed-value:
+ type: string
+ description: Captures the numeric part of the speed
+ speed-units:
+ type: string
+ description: Captures the units corresponding to the speed
+ ip-version:
+ type: string
+ description: v4, v6, or ds for dual stack
+ routing-protocol:
+ type: string
+ description: For example, static or BGP
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ model-invariant-id:
+ type: string
+ description: the ASDC model id for this resource or service model.
+ model-version-id:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ persona-model-version:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ widget-model-id:
+ type: string
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ widget-model-version:
+ type: string
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ operational-status:
+ type: string
+ description: Indication of operational status of the logical link.
+ prov-status:
+ type: string
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ link-role:
+ type: string
+ description: Indication of the network use of the logical link.
+ link-name2:
+ type: string
+ description: Alias or alternate name (CLCI or D1 name).
+ link-id:
+ type: string
+ description: UUID of the logical-link, SDNC generates this.
+ circuit-id:
+ type: string
+ description: Circuit id
+ purpose:
+ type: string
+ description: Reason for this entity, role it is playing
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ logical-links:
+ description: |
+ Collection of logical connections
+ properties:
+ logical-link:
+ type: array
+ items:
+ $ref: "#/definitions/logical-link"
+ metadata:
+ description: |
+ Collection of metadatum (key/value pairs)
+ properties:
+ metadatum:
+ type: array
+ items:
+ $ref: "#/definitions/metadatum"
+ metadatum:
+ description: |
+ Key/value pairs
+ ###### Related Nodes
+ - TO configuration( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
+ - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
+ - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
+ - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
+ - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
+ required:
+ - metaname
+ - metaval
+ properties:
+ metaname:
+ type: string
+ metaval:
+ type: string
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ model:
+ description: |
+ Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
+ ###### Related Nodes
+ - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
+ - FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
+ - FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
+ - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
+ - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
+ - MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
+ - MODEL is DELETED when these are DELETED MODEL-VER
+ required:
+ - model-invariant-id
+ - model-type
+ properties:
+ model-invariant-id:
+ type: string
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ model-type:
+ type: string
+ description: Type of the model, e.g., service, resource, widget, etc.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ model-vers:
+ type: array
+ items:
+ $ref: "#/definitions/model-ver"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ model-and-named-query-search:
+ description: |
+ ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
+ properties:
+ query-parameters:
+ type: object
+ $ref: "#/definitions/query-parameters"
+ instance-filters:
+ type: object
+ $ref: "#/definitions/instance-filters"
+ secondary-filts:
+ type: object
+ $ref: "#/definitions/secondary-filts"
+ top-node-type:
+ type: string
+ secondary-filter-cut-point:
+ type: string
+ model-constraint:
+ description: |
+ This is how we would capture constraints defining allowed sets of elements.
+ ###### Related Nodes
+ - TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
+ - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
+ - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET
+ required:
+ - model-constraint-uuid
+ - constrained-element-set-uuid-to-replace
+ properties:
+ model-constraint-uuid:
+ type: string
+ constrained-element-set-uuid-to-replace:
+ type: string
+ constrained-element-sets:
+ type: array
+ items:
+ $ref: "#/definitions/constrained-element-set"
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ model-constraints:
+ properties:
+ model-constraint:
+ type: array
+ items:
+ $ref: "#/definitions/model-constraint"
+ model-element:
+ description: |
+ Defines how other models combine to make up a higher-level model.
+ ###### Related Nodes
+ - TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
+ - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
+ - TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
+ - TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
+ - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
+ - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
+ - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
+ - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT
+ required:
+ - model-element-uuid
+ - new-data-del-flag
+ - cardinality
+ properties:
+ model-element-uuid:
+ type: string
+ new-data-del-flag:
+ type: string
+ description: Indicates whether this element was created as part of instantiation from this model
+ cardinality:
+ type: string
+ description: How many of this type of element are required/allowed
+ linkage-points:
+ type: string
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ model-elements:
+ type: array
+ items:
+ $ref: "#/definitions/model-element"
+ description: Defines how other models combine to make up a higher-level model
+ model-constraints:
+ type: array
+ items:
+ $ref: "#/definitions/model-constraint"
+ description: Describes new constraints on this model element that are not part of that model's definition
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ model-elements:
+ properties:
+ model-element:
+ type: array
+ items:
+ $ref: "#/definitions/model-element"
+ model-ver:
+ description: |
+ Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
+ ###### Related Nodes
+ - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
+ - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
+ - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
+ - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
+ - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.IsA model-ver, Many2One)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One)
+ - FROM l3-network( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One)
+ - FROM vf-module( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One)
+ - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT
+ - MODEL-VER is DELETED when these are DELETED METADATUM,MODEL-ELEMENT
+ required:
+ - model-version-id
+ - model-name
+ - model-version
+ properties:
+ model-version-id:
+ type: string
+ description: Unique identifier corresponding to one version of a model in ASDC
+ model-name:
+ type: string
+ description: Name of the model, which can change from version to version.
+ model-version:
+ type: string
+ description: Version
+ distribution-status:
+ type: string
+ description: Distribution Status
+ model-description:
+ type: string
+ description: Description
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ model-elements:
+ type: array
+ items:
+ $ref: "#/definitions/model-element"
+ metadata:
+ type: array
+ items:
+ $ref: "#/definitions/metadatum"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ model-vers:
+ properties:
+ model-ver:
+ type: array
+ items:
+ $ref: "#/definitions/model-ver"
+ models:
+ description: |
+ Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
+ properties:
+ model:
+ type: array
+ items:
+ $ref: "#/definitions/model"
+ multicast-configuration:
+ description: |
+ ###### Related Nodes
+ - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
+ required:
+ - multicast-configuration-id
+ - multicast-protocol
+ - rp-type
+ properties:
+ multicast-configuration-id:
+ type: string
+ description: Unique id of multicast configuration.
+ multicast-protocol:
+ type: string
+ description: protocol of multicast configuration
+ rp-type:
+ type: string
+ description: rp type of multicast configuration
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ multicast-configurations:
+ description: |
+ multicast configuration of generic-vnf ip-address
+ properties:
+ multicast-configuration:
+ type: array
+ items:
+ $ref: "#/definitions/multicast-configuration"
+ named-queries:
+ properties:
+ named-query:
+ type: array
+ items:
+ $ref: "#/definitions/named-query"
+ named-query:
+ description: |
+ TBD
+ ###### Related Nodes
+ - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
+ - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
+ - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
+ - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT
+ required:
+ - named-query-uuid
+ - named-query-name
+ - named-query-version
+ properties:
+ named-query-uuid:
+ type: string
+ named-query-name:
+ type: string
+ named-query-version:
+ type: string
+ required-input-param:
+ type: string
+ description:
+ type: string
+ resource-version:
+ type: string
+ named-query-elements:
+ type: array
+ items:
+ $ref: "#/definitions/named-query-element"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ named-query-element:
+ description: |
+ TBD
+ ###### Related Nodes
+ - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
+ - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
+ - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
+ - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
+ - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
+ - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
+ - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP
+ required:
+ - named-query-element-uuid
+ properties:
+ named-query-element-uuid:
+ type: string
+ property-collect-list:
+ type: string
+ resource-version:
+ type: string
+ property-limit-desc:
+ type: string
+ do-not-output:
+ type: string
+ named-query-elements:
+ type: array
+ items:
+ $ref: "#/definitions/named-query-element"
+ related-lookups:
+ type: array
+ items:
+ $ref: "#/definitions/related-lookup"
+ property-constraints:
+ type: array
+ items:
+ $ref: "#/definitions/property-constraint"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ named-query-elements:
+ properties:
+ named-query-element:
+ type: array
+ items:
+ $ref: "#/definitions/named-query-element"
+ network:
+ description: |
+ Namespace for network inventory resources.
+ properties:
+ logical-links:
+ type: array
+ items:
+ $ref: "#/definitions/logical-link"
+ site-pair-sets:
+ type: array
+ items:
+ $ref: "#/definitions/site-pair-set"
+ vpn-bindings:
+ type: array
+ items:
+ $ref: "#/definitions/vpn-binding"
+ vpls-pes:
+ type: array
+ items:
+ $ref: "#/definitions/vpls-pe"
+ multicast-configurations:
+ type: array
+ items:
+ $ref: "#/definitions/multicast-configuration"
+ vces:
+ type: array
+ items:
+ $ref: "#/definitions/vce"
+ vnfcs:
+ type: array
+ items:
+ $ref: "#/definitions/vnfc"
+ l3-networks:
+ type: array
+ items:
+ $ref: "#/definitions/l3-network"
+ network-policies:
+ type: array
+ items:
+ $ref: "#/definitions/network-policy"
+ generic-vnfs:
+ type: array
+ items:
+ $ref: "#/definitions/generic-vnf"
+ lag-links:
+ type: array
+ items:
+ $ref: "#/definitions/lag-link"
+ newvces:
+ type: array
+ items:
+ $ref: "#/definitions/newvce"
+ pnfs:
+ type: array
+ items:
+ $ref: "#/definitions/pnf"
+ physical-links:
+ type: array
+ items:
+ $ref: "#/definitions/physical-link"
+ ipsec-configurations:
+ type: array
+ items:
+ $ref: "#/definitions/ipsec-configuration"
+ route-table-references:
+ type: array
+ items:
+ $ref: "#/definitions/route-table-reference"
+ instance-groups:
+ type: array
+ items:
+ $ref: "#/definitions/instance-group"
+ zones:
+ type: array
+ items:
+ $ref: "#/definitions/zone"
+ configurations:
+ type: array
+ items:
+ $ref: "#/definitions/configuration"
+ forwarding-paths:
+ type: array
+ items:
+ $ref: "#/definitions/forwarding-path"
+ network-policies:
+ properties:
+ network-policy:
+ type: array
+ items:
+ $ref: "#/definitions/network-policy"
+ network-policy:
+ description: |
+ ###### Related Nodes
+ - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
+ - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
+ required:
+ - network-policy-id
+ properties:
+ network-policy-id:
+ type: string
+ description: UUID representing unique key to this instance
+ network-policy-fqdn:
+ type: string
+ description: Contrail FQDN for the policy
+ heat-stack-id:
+ type: string
+ description: ID for the openStack Heat instance
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ network-profile:
+ description: |
+ Network profile populated by SDN-GP for SNMP
+ ###### Related Nodes
+ - TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
+ required:
+ - nm-profile-name
+ properties:
+ nm-profile-name:
+ type: string
+ description: Unique name of network profile.
+ community-string:
+ type: string
+ description: Encrypted SNMP community string
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ network-profiles:
+ description: |
+ Collection of network profiles
+ properties:
+ network-profile:
+ type: array
+ items:
+ $ref: "#/definitions/network-profile"
+ newvce:
+ description: |
+ This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
+ ###### Related Nodes
+ - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
+ - NEWVCE is DELETED when these are DELETED L-INTERFACE
+ required:
+ - vnf-id2
+ - vnf-name
+ - vnf-type
+ properties:
+ vnf-id2:
+ type: string
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ vnf-name:
+ type: string
+ description: Name of VNF.
+ vnf-name2:
+ type: string
+ description: Alternate name of VNF.
+ vnf-type:
+ type: string
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ prov-status:
+ type: string
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ operational-status:
+ type: string
+ description: Indicator for whether the resource is considered operational
+ license-key:
+ type: string
+ description: OBSOLETE - do not use
+ ipv4-oam-address:
+ type: string
+ description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
+ equipment-role:
+ type: string
+ description: Client should send valid enumerated value.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ ipv4-loopback0-address:
+ type: string
+ description: v4 Loopback0 address
+ orchestration-status:
+ type: string
+ description: Orchestration status of this VNF, mastered by MSO.
+ heat-stack-id:
+ type: string
+ description: Heat stack id corresponding to this instance, managed by MSO
+ mso-catalog-key:
+ type: string
+ description: Corresponds to the SDN-C catalog id used to configure this VCE
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ l-interfaces:
+ type: array
+ items:
+ $ref: "#/definitions/l-interface"
+ newvces:
+ description: |
+ This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
+ properties:
+ newvce:
+ type: array
+ items:
+ $ref: "#/definitions/newvce"
+ notification-event:
+ properties:
+ cambria.partition:
+ type: string
+ notification-event-header:
+ type: object
+ $ref: "#/definitions/notification-event-header"
+ notification-event-header:
+ properties:
+ id:
+ type: string
+ timestamp:
+ type: string
+ source-name:
+ type: string
+ domain:
+ type: string
+ sequence-number:
+ type: string
+ severity:
+ type: string
+ event-type:
+ type: string
+ version:
+ type: string
+ action:
+ type: string
+ entity-type:
+ type: string
+ top-entity-type:
+ type: string
+ entity-link:
+ type: string
+ status:
+ type: string
+ notify:
+ required:
+ - event-id
+ properties:
+ event-id:
+ type: string
+ node-type:
+ type: string
+ event-trigger:
+ type: string
+ key-data:
+ type: array
+ items:
+ $ref: "#/definitions/key-data"
+ selflink:
+ type: string
+ oam-network:
+ description: |
+ OAM network, to be deprecated shortly. Do not use for new purposes.
+ ###### Related Nodes
+ - TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
+ - TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
+ required:
+ - network-uuid
+ - network-name
+ - cvlan-tag
+ properties:
+ network-uuid:
+ type: string
+ description: UUID of the network. Unique across a cloud-region
+ network-name:
+ type: string
+ description: Name of the network.
+ cvlan-tag:
+ type: integer
+ format: int64
+ description: cvlan-id
+ ipv4-oam-gateway-address:
+ type: string
+ description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
+ ipv4-oam-gateway-address-prefix-length:
+ type: integer
+ format: int32
+ description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ oam-networks:
+ description: |
+ Collection of OAM networks, to be deprecated shortly. Do not use for new purposes.
+ properties:
+ oam-network:
+ type: array
+ items:
+ $ref: "#/definitions/oam-network"
+ operational-environment:
+ description: |
+ It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
+ ###### Related Nodes
+ - TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
+ - FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
+ required:
+ - operational-environment-id
+ - operational-environment-name
+ - operational-environment-type
+ - operational-environment-status
+ - tenant-context
+ - workload-context
+ properties:
+ operational-environment-id:
+ type: string
+ description: UUID of an operational environment
+ operational-environment-name:
+ type: string
+ description: Operational Environment name
+ operational-environment-type:
+ type: string
+ description: Operational Environment Type.
+ operational-environment-status:
+ type: string
+ description: Status
+ tenant-context:
+ type: string
+ description: Tenant Context.
+ workload-context:
+ type: string
+ description: Workload Context.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ operational-environments:
+ description: |
+ a logical partition of the cloud which allows to have multiple environments in the production AIC.
+ properties:
+ operational-environment:
+ type: array
+ items:
+ $ref: "#/definitions/operational-environment"
+ overloaded-model:
+ description: |
+ Allows for legacy POST of old-style and new-style models
+ required:
+ - model-invariant-id
+ - model-name-version-id
+ - model-type
+ - model-name
+ - model-id
+ - model-version
+ properties:
+ model-invariant-id:
+ type: string
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ model-name-version-id:
+ type: string
+ description: Unique identifier corresponding to one version of a model in ASDC
+ model-type:
+ type: string
+ description: Type of the model, e.g., service, resource, widget, etc.
+ model-name:
+ type: string
+ description: Name of the model, which can change from version to version.
+ model-id:
+ type: string
+ description: Invariant unique ID which does not change from version to version
+ model-version:
+ type: string
+ description: Version
+ model-description:
+ type: string
+ description: Description
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ model-vers:
+ type: object
+ $ref: "#/definitions/model-vers"
+ relationship-list:
+ type: object
+ $ref: "#/definitions/relationship-list"
+ owning-entities:
+ description: |
+ Collection of owning-entities
+ properties:
+ owning-entity:
+ type: array
+ items:
+ $ref: "#/definitions/owning-entity"
+ owning-entity:
+ description: |
+ describes an owning-entity
+ ###### Related Nodes
+ - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
+ required:
+ - owning-entity-id
+ - owning-entity-name
+ properties:
+ owning-entity-id:
+ type: string
+ description: UUID of an owning entity
+ owning-entity-name:
+ type: string
+ description: Owning entity name
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ p-interface:
+ description: |
+ Physical interface (e.g., nic)
+ ###### Related Nodes
+ - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
+ - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
+ - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
+ - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
+ - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
+ - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
+ - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
+ - FROM sriov-pf( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
+ - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
+ - P-INTERFACE is DELETED when these are DELETED L-INTERFACE,SRIOV-PF
+ - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK
+ required:
+ - interface-name
+ - in-maint
+ properties:
+ interface-name:
+ type: string
+ description: Name that identifies the physical interface
+ selflink:
+ type: string
+ description: URL to endpoint where AAI can get more details.
+ speed-value:
+ type: string
+ description: Captures the numeric part of the speed
+ speed-units:
+ type: string
+ description: Captures the units corresponding to the speed
+ port-description:
+ type: string
+ description: Nature of the services and connectivity on this port.
+ equipment-identifier:
+ type: string
+ description: CLEI or other specification for p-interface hardware.
+ interface-role:
+ type: string
+ description: Role specification for p-interface hardware.
+ interface-type:
+ type: string
+ description: Indicates the physical properties of the interface.
+ prov-status:
+ type: string
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ mac-addresss:
+ type: string
+ description: MAC Address of the p-interface.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ in-maint:
+ type: boolean
+ inv-status:
+ type: string
+ description: inventory status
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ sriov-pfs:
+ type: array
+ items:
+ $ref: "#/definitions/sriov-pf"
+ l-interfaces:
+ type: array
+ items:
+ $ref: "#/definitions/l-interface"
+ p-interfaces:
+ description: |
+ Collection of physical interfaces.
+ properties:
+ p-interface:
+ type: array
+ items:
+ $ref: "#/definitions/p-interface"
+ physical-link:
+ description: |
+ Collection of physical connections, typically between p-interfaces
+ ###### Related Nodes
+ - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
+ required:
+ - link-name
+ properties:
+ link-name:
+ type: string
+ description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
+ speed-value:
+ type: string
+ description: Captures the numeric part of the speed
+ speed-units:
+ type: string
+ description: Captures the units corresponding to the speed
+ circuit-id:
+ type: string
+ description: Circuit it
+ dual-mode:
+ type: string
+ description: Dual access mode (e.g., primary, secondary
+ management-option:
+ type: string
+ description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
+ service-provider-name:
+ type: string
+ description: Name of the service Provider on this link.
+ service-provider-bandwidth-up-value:
+ type: integer
+ format: int32
+ description: Upstream Bandwidth value agreed with the service provider
+ service-provider-bandwidth-up-units:
+ type: string
+ description: Units for the upstream BW value
+ service-provider-bandwidth-down-value:
+ type: integer
+ format: int32
+ description: Downstream Bandwidth value agreed with the service provider
+ service-provider-bandwidth-down-units:
+ type: string
+ description: Units for downstream BW value
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ physical-links:
+ description: |
+ Collection of physical connections, typically between p-interfaces
+ properties:
+ physical-link:
+ type: array
+ items:
+ $ref: "#/definitions/physical-link"
+ platform:
+ description: |
+ describes a platform
+ ###### Related Nodes
+ - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
+ required:
+ - platform-name
+ properties:
+ platform-name:
+ type: string
+ description: Name of the platform
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ platforms:
+ description: |
+ Collection of platforms
+ properties:
+ platform:
+ type: array
+ items:
+ $ref: "#/definitions/platform"
+ pnf:
+ 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.
+ ###### Related Nodes
+ - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
+ - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc has pnf, One2Many)
+ - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
+ - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
+ - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
+ - FROM configuration( configuration org.onap.relationships.inventory.AppliesTo pnf, ONE2MANY)
+ - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
+ required:
+ - pnf-name
+ - in-maint
+ properties:
+ pnf-name:
+ type: string
+ description: unique name of Physical Network Function.
+ pnf-name2:
+ type: string
+ description: name of Physical Network Function.
+ selflink:
+ type: string
+ description: URL to endpoint where AAI can get more details.
+ pnf-name2-source:
+ type: string
+ description: source of name2
+ pnf-id:
+ type: string
+ description: id of pnf
+ equip-type:
+ type: string
+ description: Equipment type. Source of truth should define valid values.
+ equip-vendor:
+ type: string
+ description: Equipment vendor. Source of truth should define valid values.
+ equip-model:
+ type: string
+ description: Equipment model. Source of truth should define valid values.
+ management-option:
+ type: string
+ description: identifier of managed by ATT or customer
+ ipaddress-v4-oam:
+ type: string
+ description: ipv4-oam-address with new naming convention for IP addresses
+ sw-version:
+ type: string
+ description: sw-version is the version of SW for the hosted application on the PNF.
+ in-maint:
+ type: boolean
+ frame-id:
+ type: string
+ description: ID of the physical frame (relay rack) where pnf is installed.
+ serial-number:
+ type: string
+ description: Serial number of the device
+ ipaddress-v4-loopback-0:
+ type: string
+ description: IPV4 Loopback 0 address
+ ipaddress-v6-loopback-0:
+ type: string
+ description: IPV6 Loopback 0 address
+ ipaddress-v4-aim:
+ type: string
+ description: IPV4 AIM address
+ ipaddress-v6-aim:
+ type: string
+ description: IPV6 AIM address
+ ipaddress-v6-oam:
+ type: string
+ description: IPV6 OAM address
+ inv-status:
+ type: string
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ prov-status:
+ type: string
+ description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
+ nf-role:
+ type: string
+ description: Nf Role is the role performed by this instance in the network.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ p-interfaces:
+ type: array
+ items:
+ $ref: "#/definitions/p-interface"
+ lag-interfaces:
+ type: array
+ items:
+ $ref: "#/definitions/lag-interface"
+ pnfs:
+ description: |
+ Collection of Physical Network Functions.
+ properties:
+ pnf:
+ type: array
+ items:
+ $ref: "#/definitions/pnf"
+ port-group:
+ description: |
+ Used to capture the network interfaces of this VCE
+ ###### Related Nodes
+ - TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
+ - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE)
+ - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG
+ required:
+ - interface-id
+ - orchestration-status
+ properties:
+ interface-id:
+ type: string
+ description: Unique ID of the interface
+ neutron-network-id:
+ type: string
+ description: Neutron network id of this Interface
+ neutron-network-name:
+ type: string
+ description: Neutron network name of this Interface
+ interface-role:
+ type: string
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ port-group-id:
+ type: string
+ description: Unique ID for port group in vmware
+ port-group-name:
+ type: string
+ description: Likely to duplicate value of neutron network name
+ switch-name:
+ type: string
+ description: DVS or standard switch name (should be non-null for port groups associated with DVS)
+ orchestration-status:
+ type: string
+ description: Orchestration status of this VNF, mastered by MSO
+ heat-stack-id:
+ type: string
+ description: Heat stack id corresponding to this instance, managed by MSO
+ mso-catalog-key:
+ type: string
+ description: Corresponds to the SDN-C catalog id used to configure this VCE
+ cvlan-tags:
+ type: array
+ items:
+ $ref: "#/definitions/cvlan-tag-entry"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ port-groups:
+ properties:
+ port-group:
+ type: array
+ items:
+ $ref: "#/definitions/port-group"
+ project:
+ description: |
+ describes the project
+ ###### Related Nodes
+ - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
+ required:
+ - project-name
+ properties:
+ project-name:
+ type: string
+ description: Name of the project deploying a service
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ projects:
+ description: |
+ Collection of projects
+ properties:
+ project:
+ type: array
+ items:
+ $ref: "#/definitions/project"
+ properties:
+ description: |
+ Property holder for query properties or instance properties
+ properties:
+ property-name:
+ type: string
+ property-value:
+ type: string
+ property-constraint:
+ description: |
+ TBD
+ ###### Related Nodes
+ - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
+ required:
+ - property-constraint-uuid
+ - constraint-type
+ - property-name
+ - property-value
+ properties:
+ property-constraint-uuid:
+ type: string
+ constraint-type:
+ type: string
+ property-name:
+ type: string
+ property-value:
+ type: string
+ resource-version:
+ type: string
+ property-constraints:
+ properties:
+ property-constraint:
+ type: array
+ items:
+ $ref: "#/definitions/property-constraint"
+ pserver:
+ description: |
+ Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
+ ###### Related Nodes
+ - TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
+ - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
+ - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
+ - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
+ - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
+ - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
+ - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
+ - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
+ - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER
+ - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
+ - PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT
+ required:
+ - hostname
+ - in-maint
+ properties:
+ hostname:
+ type: string
+ description: Value from executing hostname on the compute node.
+ ptnii-equip-name:
+ type: string
+ description: PTNII name
+ number-of-cpus:
+ type: integer
+ format: int32
+ description: Number of cpus
+ disk-in-gigabytes:
+ type: integer
+ format: int32
+ description: Disk size, in GBs
+ ram-in-megabytes:
+ type: integer
+ format: int32
+ description: RAM size, in MBs
+ equip-type:
+ type: string
+ description: Equipment type. Source of truth should define valid values.
+ equip-vendor:
+ type: string
+ description: Equipment vendor. Source of truth should define valid values.
+ equip-model:
+ type: string
+ description: Equipment model. Source of truth should define valid values.
+ fqdn:
+ type: string
+ description: Fully-qualified domain name
+ pserver-selflink:
+ type: string
+ description: URL to endpoint where AAI can get more details
+ ipv4-oam-address:
+ type: string
+ description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
+ serial-number:
+ type: string
+ description: Serial number, may be queried
+ ipaddress-v4-loopback-0:
+ type: string
+ description: IPV4 Loopback 0 address
+ ipaddress-v6-loopback-0:
+ type: string
+ description: IPV6 Loopback 0 address
+ ipaddress-v4-aim:
+ type: string
+ description: IPV4 AIM address
+ ipaddress-v6-aim:
+ type: string
+ description: IPV6 AIM address
+ ipaddress-v6-oam:
+ type: string
+ description: IPV6 OAM address
+ inv-status:
+ type: string
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ pserver-id:
+ type: string
+ description: ID of Pserver
+ internet-topology:
+ type: string
+ description: internet topology of Pserver
+ in-maint:
+ type: boolean
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ pserver-name2:
+ type: string
+ description: alternative pserver name
+ purpose:
+ type: string
+ description: purpose of pserver
+ prov-status:
+ type: string
+ description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
+ management-option:
+ type: string
+ description: Indicates who owns and or manages the device.
+ host-profile:
+ type: string
+ description: The host profile that defines the configuration of the pserver.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ p-interfaces:
+ type: array
+ items:
+ $ref: "#/definitions/p-interface"
+ lag-interfaces:
+ type: array
+ items:
+ $ref: "#/definitions/lag-interface"
+ pservers:
+ description: |
+ Collection of compute hosts.
+ properties:
+ pserver:
+ type: array
+ items:
+ $ref: "#/definitions/pserver"
+ query-parameters:
+ description: |
+ QueryParameters for performing a named-query or model query
+ properties:
+ named-query:
+ type: object
+ $ref: "#/definitions/named-query"
+ overloaded-model:
+ type: object
+ $ref: "#/definitions/overloaded-model"
+ related-lookup:
+ description: |
+ TBD
+ ###### Related Nodes
+ - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
+ required:
+ - related-lookup-uuid
+ - source-node-type
+ - source-node-property
+ - target-node-type
+ - target-node-property
+ properties:
+ related-lookup-uuid:
+ type: string
+ source-node-type:
+ type: string
+ source-node-property:
+ type: string
+ target-node-type:
+ type: string
+ target-node-property:
+ type: string
+ property-collect-list:
+ type: string
+ resource-version:
+ type: string
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ related-lookups:
+ properties:
+ related-lookup:
+ type: array
+ items:
+ $ref: "#/definitions/related-lookup"
+ related-to-property:
+ properties:
+ property-key:
+ type: string
+ description: Key part of a key/value pair
+ property-value:
+ type: string
+ description: Value part of a key/value pair
+ relationship:
+ properties:
+ related-to:
+ type: string
+ description: A keyword provided by A&AI to indicate type of node.
+ relationship-label:
+ type: string
+ description: The edge label for this relationship.
+ related-link:
+ type: string
+ description: URL to the object in A&AI.
+ relationship-data:
+ type: array
+ items:
+ $ref: "#/definitions/relationship-data"
+ relationship-data:
+ required:
+ - relationship-key
+ - relationship-value
+ properties:
+ relationship-key:
+ type: string
+ description: A keyword provided by A&AI to indicate an attribute.
+ relationship-value:
+ type: string
+ description: Value of the attribute.
+ relationship-list:
+ properties:
+ relationship:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ reserved-prop-names:
+ description: |
+ Internal map to define some reserved properties of a vertex
+ properties:
+ last-mod-source-of-truth:
+ type: string
+ aai-node-type:
+ type: string
+ aai-created-ts:
+ type: integer
+ format: int64
+ aai-unique-key:
+ type: string
+ aai-last-mod-ts:
+ type: integer
+ format: int64
+ source-of-truth:
+ type: string
+ aai-uri:
+ type: string
+ response-list:
+ description: |
+ Response container for the results of a named-query or model query
+ properties:
+ inventory-response-items:
+ type: object
+ $ref: "#/definitions/inventory-response-items"
+ result-data:
+ properties:
+ resource-type:
+ type: string
+ description: The specific type of node in the A&AI graph
+ resource-link:
+ type: string
+ description: The URL to the specific resource
+ route-table-reference:
+ description: |
+ Openstack route table reference.
+ ###### Related Nodes
+ - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
+ required:
+ - route-table-reference-id
+ - route-table-reference-fqdn
+ properties:
+ route-table-reference-id:
+ type: string
+ description: Route Table Reference id, UUID assigned to this instance.
+ route-table-reference-fqdn:
+ type: string
+ description: FQDN entry in the route table.
+ resource-version:
+ type: string
+ description: Concurrency value
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ route-table-references:
+ description: |
+ Collection of openstack route table references
+ properties:
+ route-table-reference:
+ type: array
+ items:
+ $ref: "#/definitions/route-table-reference"
+ route-target:
+ description: |
+ Route target information
+ ###### Related Nodes
+ - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
+ required:
+ - global-route-target
+ - route-target-role
+ properties:
+ global-route-target:
+ type: string
+ description: Number used to identify an RT, globally unique in the network
+ route-target-role:
+ type: string
+ description: Role assigned to this route target
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ route-targets:
+ description: |
+ Collection of route target information
+ properties:
+ route-target:
+ type: array
+ items:
+ $ref: "#/definitions/route-target"
+ routing-instance:
+ description: |
+ ###### Related Nodes
+ - TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
+ - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
+ - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR
+ required:
+ - routing-instance-id
+ properties:
+ routing-instance-id:
+ type: string
+ description: Unique id of routing instance
+ rpm-owner:
+ type: string
+ description: rpm owner
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ site-pairs:
+ type: array
+ items:
+ $ref: "#/definitions/site-pair"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ routing-instances:
+ description: |
+ set of probes related to generic-vnf routing instance
+ properties:
+ routing-instance:
+ type: array
+ items:
+ $ref: "#/definitions/routing-instance"
+ sdn-zone-response:
+ properties:
+ oam-networks:
+ type: object
+ $ref: "#/definitions/oam-networks"
+ az-and-dvs-switches:
+ type: array
+ items:
+ $ref: "#/definitions/az-and-dvs-switches"
+ search:
+ properties:
+ edge-tag-query-result:
+ type: object
+ $ref: "#/definitions/edge-tag-query-result"
+ edge-tag-query-request:
+ type: object
+ $ref: "#/definitions/edge-tag-query-request"
+ search-results:
+ type: object
+ $ref: "#/definitions/search-results"
+ sdn-zone-response:
+ type: object
+ $ref: "#/definitions/sdn-zone-response"
+ search-results:
+ properties:
+ result-data:
+ type: array
+ items:
+ $ref: "#/definitions/result-data"
+ secondary-filt:
+ description: |
+ SecondaryFilt for performing a named-query or model query
+ secondary-filter:
+ properties:
+ property-name:
+ type: string
+ filter-type:
+ type: string
+ property-value:
+ type: string
+ secondary-filts:
+ description: |
+ SecondaryFilts for performing a named-query or model query
+ properties:
+ secondary-filt:
+ type: array
+ items:
+ $ref: "#/definitions/secondary-filt"
+ segmentation-assignment:
+ description: |
+ Openstack segmentation assignment.
+ ###### Related Nodes
+ - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
+ required:
+ - segmentation-id
+ properties:
+ segmentation-id:
+ type: string
+ description: Route Table Reference id, UUID assigned to this instance.
+ resource-version:
+ type: string
+ description: Concurrency value
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ segmentation-assignments:
+ description: |
+ Collection of openstack segmentation assignments
+ properties:
+ segmentation-assignment:
+ type: array
+ items:
+ $ref: "#/definitions/segmentation-assignment"
+ service:
+ description: |
+ Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services.
+ required:
+ - service-id
+ - service-description
+ properties:
+ service-id:
+ type: string
+ description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
+ service-description:
+ type: string
+ description: Description of the service
+ service-selflink:
+ type: string
+ description: URL to endpoint where AAI can get more details
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ service-version:
+ type: string
+ description: service version
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ service-capabilities:
+ description: |
+ Collection of service capabilities.
+ properties:
+ service-capability:
+ type: array
+ items:
+ $ref: "#/definitions/service-capability"
+ service-capability:
+ description: |
+ Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this.
+ ###### Related Nodes
+ - FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
+ - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
+ - SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK
+ required:
+ - service-type
+ - vnf-type
+ properties:
+ service-type:
+ type: string
+ description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
+ vnf-type:
+ type: string
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ service-design-and-creation:
+ description: |
+ Namespace for objects managed by ASDC
+ properties:
+ vnf-images:
+ type: array
+ items:
+ $ref: "#/definitions/vnf-image"
+ services:
+ type: array
+ items:
+ $ref: "#/definitions/service"
+ service-capabilities:
+ type: array
+ items:
+ $ref: "#/definitions/service-capability"
+ models:
+ type: array
+ items:
+ $ref: "#/definitions/model"
+ named-queries:
+ type: array
+ items:
+ $ref: "#/definitions/named-query"
+ service-instance:
+ description: |
+ Instance of a service
+ ###### Related Nodes
+ - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
+ - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
+ - TO owning-entity( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
+ - TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
+ - TO configuration( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
+ - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
+ - TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
+ - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY)
+ - TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
+ - TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
+ - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
+ - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
+ - TO zone( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
+ - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
+ - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
+ - TO model-ver( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One)
+ - FROM project( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
+ - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
+ - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
+ - FROM forwarding-path( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
+ - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM,FORWARDING-PATH
+ - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
+ required:
+ - service-instance-id
+ - service-type
+ - service-role
+ - created-at
+ - updated-at
+ - description
+ properties:
+ service-instance-id:
+ type: string
+ description: Uniquely identifies this instance of a service
+ service-instance-name:
+ type: string
+ description: This field will store a name assigned to the service-instance.
+ service-type:
+ type: string
+ description: String capturing type of service.
+ service-role:
+ type: string
+ description: String capturing the service role.
+ environment-context:
+ type: string
+ description: This field will store the environment context assigned to the service-instance.
+ workload-context:
+ type: string
+ description: This field will store the workload context assigned to the service-instance.
+ created-at:
+ type: string
+ description: create time of Network Service.
+ updated-at:
+ type: string
+ description: last update of Network Service.
+ description:
+ type: string
+ description: short description for service-instance.
+ model-invariant-id:
+ type: string
+ description: the ASDC model id for this resource or service model.
+ model-version-id:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ persona-model-version:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ widget-model-id:
+ type: string
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ widget-model-version:
+ type: string
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ bandwidth-total:
+ type: string
+ description: Indicates the total bandwidth to be used for this service.
+ bandwidth-up-wan1:
+ type: string
+ description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
+ bandwidth-down-wan1:
+ type: string
+ description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
+ bandwidth-up-wan2:
+ type: string
+ description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
+ bandwidth-down-wan2:
+ type: string
+ description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
+ vhn-portal-url:
+ type: string
+ description: URL customers will use to access the vHN Portal.
+ service-instance-location-id:
+ type: string
+ description: An identifier that customers assign to the location where this service is being used.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ selflink:
+ type: string
+ description: Path to the controller object.
+ orchestration-status:
+ type: string
+ description: Orchestration status of this service.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ metadata:
+ type: array
+ items:
+ $ref: "#/definitions/metadatum"
+ allotted-resources:
+ type: array
+ items:
+ $ref: "#/definitions/allotted-resource"
+ service-instances:
+ description: |
+ Collection of service instances
+ properties:
+ service-instance:
+ type: array
+ items:
+ $ref: "#/definitions/service-instance"
+ service-subscription:
+ description: |
+ Object that group service instances.
+ ###### Related Nodes
+ - TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
+ - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
+ - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE
+ required:
+ - service-type
+ properties:
+ service-type:
+ type: string
+ description: Value defined by orchestration to identify this service across ECOMP.
+ temp-ub-sub-account-id:
+ type: string
+ description: This property will be deleted from A&AI in the near future. Only stop gap solution.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ service-instances:
+ type: array
+ items:
+ $ref: "#/definitions/service-instance"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ service-subscriptions:
+ description: |
+ Collection of objects that group service instances.
+ properties:
+ service-subscription:
+ type: array
+ items:
+ $ref: "#/definitions/service-subscription"
+ services:
+ description: |
+ Collection of service model definitions. Likely to be deprecated in favor of models from ASDC.
+ properties:
+ service:
+ type: array
+ items:
+ $ref: "#/definitions/service"
+ site-pair:
+ description: |
+ ###### Related Nodes
+ - TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
+ - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
+ - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE
+ required:
+ - site-pair-id
+ properties:
+ site-pair-id:
+ type: string
+ description: unique identifier of probe
+ source-ip:
+ type: string
+ description: Prefix address
+ destination-ip:
+ type: string
+ description: Prefix address
+ ip-version:
+ type: string
+ description: ip version, v4, v6
+ destination-hostname:
+ type: string
+ description: Hostname of the destination equipment to which SLAs are measured against.
+ destination-equip-type:
+ type: string
+ description: The type of destinatination equipment. Could be Router, UCPE, etc.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ classes-of-service:
+ type: array
+ items:
+ $ref: "#/definitions/class-of-service"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ site-pair-set:
+ description: |
+ Set of instances for probes used to measure service level agreements
+ ###### Related Nodes
+ - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
+ - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
+ - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE
+ required:
+ - site-pair-set-id
+ properties:
+ site-pair-set-id:
+ type: string
+ description: Unique id of site pair set.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ routing-instances:
+ type: array
+ items:
+ $ref: "#/definitions/routing-instance"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ site-pair-sets:
+ description: |
+ Collection of sets of instances for probes related to generic-vnf
+ properties:
+ site-pair-set:
+ type: array
+ items:
+ $ref: "#/definitions/site-pair-set"
+ site-pairs:
+ description: |
+ probe within a set
+ properties:
+ site-pair:
+ type: array
+ items:
+ $ref: "#/definitions/site-pair"
+ snapshot:
+ description: |
+ Openstack snapshot
+ ###### Related Nodes
+ - TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
+ required:
+ - snapshot-id
+ properties:
+ snapshot-id:
+ type: string
+ description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
+ snapshot-name:
+ type: string
+ description: Snapshot name
+ snapshot-architecture:
+ type: string
+ description: Operating system architecture
+ snapshot-os-distro:
+ type: string
+ description: The common name of the operating system distribution in lowercase
+ snapshot-os-version:
+ type: string
+ description: The operating system version as specified by the distributor.
+ application:
+ type: string
+ description: The application that the image instantiates.
+ application-vendor:
+ type: string
+ description: The vendor of the application.
+ application-version:
+ type: string
+ description: The version of the application.
+ snapshot-selflink:
+ type: string
+ description: URL to endpoint where AAI can get more details
+ prev-snapshot-id:
+ type: string
+ description: This field contains the UUID of the previous snapshot (if any).
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ snapshots:
+ description: |
+ Collection of openstack snapshots
+ properties:
+ snapshot:
+ type: array
+ items:
+ $ref: "#/definitions/snapshot"
+ sriov-pf:
+ description: |
+ SR-IOV Physical Function
+ ###### Related Nodes
+ - TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
+ - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
+ required:
+ - pf-pci-id
+ properties:
+ pf-pci-id:
+ type: string
+ description: Identifier for the sriov-pf
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ sriov-pfs:
+ description: |
+ Collection of SR-IOV Physical Functions.
+ properties:
+ sriov-pf:
+ type: array
+ items:
+ $ref: "#/definitions/sriov-pf"
+ sriov-vf:
+ description: |
+ SR-IOV Virtual Function (not to be confused with virtual network function)
+ ###### Related Nodes
+ - TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
+ - TO sriov-pf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
+ required:
+ - pci-id
+ properties:
+ pci-id:
+ type: string
+ description: PCI ID used to identify the sriov-vf
+ vf-vlan-filter:
+ type: string
+ description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
+ vf-mac-filter:
+ type: string
+ description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
+ vf-vlan-strip:
+ type: boolean
+ description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
+ vf-vlan-anti-spoof-check:
+ type: boolean
+ description: This option ensures anti VLAN spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.
+ vf-mac-anti-spoof-check:
+ type: boolean
+ description: This option ensures anti MAC spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.
+ vf-mirrors:
+ type: string
+ description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
+ vf-broadcast-allow:
+ type: boolean
+ description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
+ vf-unknown-multicast-allow:
+ type: boolean
+ description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
+ vf-unknown-unicast-allow:
+ type: boolean
+ description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
+ vf-insert-stag:
+ type: boolean
+ description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
+ vf-link-status:
+ type: string
+ description: This option is used to set the link status. Valid values as of 1607 are on, off, and auto.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ neutron-network-id:
+ type: string
+ description: Neutron network id of the interface
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ sriov-vfs:
+ description: |
+ Collection of SR-IOV Virtual Functions.
+ properties:
+ sriov-vf:
+ type: array
+ items:
+ $ref: "#/definitions/sriov-vf"
+ start-node-filter:
+ properties:
+ property-name:
+ type: string
+ property-value:
+ type: string
+ subnet:
+ description: |
+ ###### Related Nodes
+ - TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
+ - FROM host-route( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
+ - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
+ - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
+ - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST
+ - SUBNET is DELETED when these are DELETED HOST-ROUTE
+ required:
+ - subnet-id
+ - dhcp-enabled
+ properties:
+ subnet-id:
+ type: string
+ description: Subnet ID, should be UUID.
+ subnet-name:
+ type: string
+ description: Name associated with the subnet.
+ neutron-subnet-id:
+ type: string
+ description: Neutron id of this subnet
+ gateway-address:
+ type: string
+ description: gateway ip address
+ network-start-address:
+ type: string
+ description: network start address
+ cidr-mask:
+ type: string
+ description: cidr mask
+ ip-version:
+ type: string
+ description: ip version
+ orchestration-status:
+ type: string
+ description: Orchestration status of this VNF, mastered by MSO
+ dhcp-enabled:
+ type: boolean
+ dhcp-start:
+ type: string
+ description: the start address reserved for use by dhcp
+ dhcp-end:
+ type: string
+ description: the last address reserved for use by dhcp
+ subnet-role:
+ type: string
+ description: role of the subnet, referenced when assigning IPs
+ ip-assignment-direction:
+ type: string
+ description: ip address assignment direction of the subnet
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ subnet-sequence:
+ type: integer
+ format: int32
+ description: sequence of the subnet
+ host-routes:
+ type: array
+ items:
+ $ref: "#/definitions/host-route"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ subnets:
+ properties:
+ subnet:
+ type: array
+ items:
+ $ref: "#/definitions/subnet"
+ tagged-inventory-item-list:
+ properties:
+ inventory-item:
+ type: array
+ items:
+ $ref: "#/definitions/inventory-item"
+ tenant:
+ description: |
+ Openstack tenant
+ ###### Related Nodes
+ - TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
+ - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
+ - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
+ - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
+ - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
+ - TENANT cannot be deleted if linked to VSERVER
+ required:
+ - tenant-id
+ - tenant-name
+ properties:
+ tenant-id:
+ type: string
+ description: Unique id relative to the cloud-region.
+ tenant-name:
+ type: string
+ description: Readable name of tenant
+ tenant-context:
+ type: string
+ description: This field will store the tenant context.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ vservers:
+ type: array
+ items:
+ $ref: "#/definitions/vserver"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ tenants:
+ description: |
+ Collection of openstack tenants.
+ properties:
+ tenant:
+ type: array
+ items:
+ $ref: "#/definitions/tenant"
+ tunnel-xconnect:
+ description: |
+ Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
+ ###### Related Nodes
+ - TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
+ required:
+ - id
+ properties:
+ id:
+ type: string
+ description: Allotted Resource id UUID assigned to this instance.
+ bandwidth-up-wan1:
+ type: string
+ description: The WAN uplink bandwidth for WAN1
+ bandwidth-down-wan1:
+ type: string
+ description: The WAN downlink bandwidth for WAN1
+ bandwidth-up-wan2:
+ type: string
+ description: The WAN uplink bandwidth for WAN2
+ bandwidth-down-wan2:
+ type: string
+ description: The WAN downlink bandwidth for WAN2
+ resource-version:
+ type: string
+ description: Concurrency value
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ tunnel-xconnects:
+ description: |
+ This object is used to store the specific tunnel cross connect aspects of an allotted resource
+ properties:
+ tunnel-xconnect:
+ type: array
+ items:
+ $ref: "#/definitions/tunnel-xconnect"
+ update:
+ description: |
+ Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team.
+ required:
+ - update-node-type
+ properties:
+ update-node-type:
+ type: string
+ update-node-key:
+ type: array
+ items:
+ $ref: "#/definitions/update-node-key"
+ update-node-uri:
+ type: string
+ action:
+ type: array
+ items:
+ $ref: "#/definitions/action"
+ update-node-key:
+ properties:
+ key-name:
+ type: string
+ key-value:
+ type: string
+ vce:
+ description: |
+ Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated.
+ ###### Related Nodes
+ - TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
+ - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
+ - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY)
+ - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
+ - FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
+ - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
+ - VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP
+ required:
+ - vnf-id
+ - vnf-name
+ - vnf-type
+ properties:
+ vnf-id:
+ type: string
+ description: Unique id of VNF. This is unique across the graph.
+ vnf-name:
+ type: string
+ description: Name of VNF.
+ vnf-name2:
+ type: string
+ description: Alternate name of VNF.
+ vnf-type:
+ type: string
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ service-id:
+ type: string
+ description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
+ regional-resource-zone:
+ type: string
+ description: Regional way of organizing pservers, source of truth should define values
+ prov-status:
+ type: string
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ operational-status:
+ type: string
+ description: Indicator for whether the resource is considered operational
+ license-key:
+ type: string
+ description: OBSOLETE - do not use
+ equipment-role:
+ type: string
+ description: Network role being played by this VNF
+ orchestration-status:
+ type: string
+ description: Orchestration status of this VNF, mastered by MSO
+ heat-stack-id:
+ type: string
+ description: Heat stack id corresponding to this instance, managed by MSO
+ mso-catalog-key:
+ type: string
+ description: Corresponds to the SDN-C catalog id used to configure this VCE
+ vpe-id:
+ type: string
+ description: Unique ID of VPE connected to this VCE.
+ v6-vce-wan-address:
+ type: string
+ description: Valid v6 IP address for the WAN Link on this router. Implied length of /64.
+ ipv4-oam-address:
+ type: string
+ description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ ipv4-loopback0-address:
+ type: string
+ description: Loopback0 address
+ entitlement-resource-uuid:
+ type: string
+ description: OBSOLETE - see child relationships
+ port-groups:
+ type: array
+ items:
+ $ref: "#/definitions/port-group"
+ licenses:
+ type: array
+ items:
+ $ref: "#/definitions/license"
+ entitlements:
+ type: array
+ items:
+ $ref: "#/definitions/entitlement"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ vces:
+ description: |
+ Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated.
+ properties:
+ vce:
+ type: array
+ items:
+ $ref: "#/definitions/vce"
+ vf-module:
+ description: |
+ a deployment unit of VNFCs
+ ###### Related Nodes
+ - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
+ - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
+ - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
+ - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
+ - TO model-ver( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One)
+ - VF-MODULE cannot be deleted if linked to VNFC
+ required:
+ - vf-module-id
+ - is-base-vf-module
+ properties:
+ vf-module-id:
+ type: string
+ description: Unique ID of vf-module.
+ vf-module-name:
+ type: string
+ description: Name of vf-module
+ heat-stack-id:
+ type: string
+ description: Heat stack id corresponding to this instance.
+ orchestration-status:
+ type: string
+ description: orchestration status of this vf-module, mastered by MSO
+ is-base-vf-module:
+ type: boolean
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ model-invariant-id:
+ type: string
+ description: the ASDC model id for this resource or service model.
+ model-version-id:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ persona-model-version:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ model-customization-id:
+ type: string
+ description: captures the id of all the configuration used to customize the resource for the service.
+ widget-model-id:
+ type: string
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ widget-model-version:
+ type: string
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ contrail-service-instance-fqdn:
+ type: string
+ description: the Contrail unique ID for a service-instance
+ module-index:
+ type: integer
+ format: int32
+ description: the index will track the number of modules of a given type that have been deployed in a VNF, starting with 0, and always choosing the lowest available digit
+ selflink:
+ type: string
+ description: Path to the controller object.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ vf-modules:
+ description: |
+ Collection of vf-modules, a deployment unit of VNFCs
+ properties:
+ vf-module:
+ type: array
+ items:
+ $ref: "#/definitions/vf-module"
+ vig-server:
+ description: |
+ vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
+ ###### Related Nodes
+ - TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
+ required:
+ - vig-address-type
+ properties:
+ vig-address-type:
+ type: string
+ description: indicates whether the VIG is for AVPN or INTERNET
+ ipaddress-v4-vig:
+ type: string
+ description: v4 IP of the vig server
+ ipaddress-v6-vig:
+ type: string
+ description: v6 IP of the vig server
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ vig-servers:
+ properties:
+ vig-server:
+ type: array
+ items:
+ $ref: "#/definitions/vig-server"
+ vip-ipv4-address-list:
+ description: |
+ IPv4 Address Range
+ ###### Related Nodes
+ - TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
+ - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
+ required:
+ - vip-ipv4-address
+ properties:
+ vip-ipv4-address:
+ type: string
+ description: IP address
+ vip-ipv4-prefix-length:
+ type: integer
+ format: int64
+ description: Prefix length, 32 for single address
+ vlan-id-inner:
+ type: integer
+ format: int64
+ description: Inner VLAN tag
+ vlan-id-outer:
+ type: integer
+ format: int64
+ description: Outer VLAN tag
+ is-floating:
+ type: boolean
+ description: Indicator of fixed or floating address
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ neutron-network-id:
+ type: string
+ description: Neutron network id of the interface that address belongs to
+ neutron-subnet-id:
+ type: string
+ description: Neutron id of subnet that address belongs to
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ vip-ipv6-address-list:
+ description: |
+ IPv6 Address Range
+ ###### Related Nodes
+ - TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
+ - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
+ required:
+ - vip-ipv6-address
+ properties:
+ vip-ipv6-address:
+ type: string
+ description: IP address
+ vip-ipv6-prefix-length:
+ type: integer
+ format: int64
+ description: Prefix length, 128 for single address
+ vlan-id-inner:
+ type: integer
+ format: int64
+ description: Inner VLAN tag
+ vlan-id-outer:
+ type: integer
+ format: int64
+ description: Outer VLAN tag
+ is-floating:
+ type: boolean
+ description: Indicator of fixed or floating address
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ neutron-network-id:
+ type: string
+ description: Neutron network id of the interface that address belongs to
+ neutron-subnet-id:
+ type: string
+ description: Neutron id of subnet that address belongs to
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ virtual-data-center:
+ description: |
+ Virtual organization of cloud infrastructure elements in a data center context
+ ###### Related Nodes
+ - FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
+ required:
+ - vdc-id
+ - vdc-name
+ properties:
+ vdc-id:
+ type: string
+ description: Unique ID of the vdc
+ vdc-name:
+ type: string
+ description: Name of the virtual data center
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ virtual-data-centers:
+ description: |
+ Virtual organization of cloud infrastructure elements in a data center context
+ properties:
+ virtual-data-center:
+ type: array
+ items:
+ $ref: "#/definitions/virtual-data-center"
+ vlan:
+ description: |
+ Definition of vlan
+ ###### Related Nodes
+ - TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
+ - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
+ - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
+ - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
+ - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
+ - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK
+ required:
+ - vlan-interface
+ - in-maint
+ - is-ip-unnumbered
+ properties:
+ vlan-interface:
+ type: string
+ description: String that identifies the interface
+ vlan-id-inner:
+ type: integer
+ format: int64
+ description: Inner VLAN tag
+ vlan-id-outer:
+ type: integer
+ format: int64
+ description: Outer VLAN tag
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ speed-value:
+ type: string
+ description: Captures the numeric part of the speed
+ speed-units:
+ type: string
+ description: Captures the units corresponding to the speed
+ vlan-description:
+ type: string
+ description: Used to describe (the service associated with) the vlan
+ backdoor-connection:
+ type: string
+ description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
+ vpn-key:
+ type: string
+ description: This indicates the customers VPN ID associated with this vlan
+ orchestration-status:
+ type: string
+ description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.
+ in-maint:
+ type: boolean
+ prov-status:
+ type: string
+ description: Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV].
+ is-ip-unnumbered:
+ type: boolean
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ l3-interface-ipv4-address-list:
+ type: array
+ items:
+ $ref: "#/definitions/l3-interface-ipv4-address-list"
+ l3-interface-ipv6-address-list:
+ type: array
+ items:
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
+ vlans:
+ properties:
+ vlan:
+ type: array
+ items:
+ $ref: "#/definitions/vlan"
+ vnf:
+ description: |
+ Abstract vnf class
+ required:
+ - vnf-id
+ properties:
+ vnf-id:
+ type: string
+ description: Unique id of VNF. This is unique across the graph.
+ vnf-image:
+ description: |
+ Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge.
+ ###### Related Nodes
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
+ - VNF-IMAGE cannot be deleted if linked to GENERIC-VNF
+ required:
+ - vnf-image-uuid
+ - application
+ - application-vendor
+ properties:
+ vnf-image-uuid:
+ type: string
+ description: Unique ID of this asset
+ application:
+ type: string
+ description: The application that the image instantiates.
+ application-vendor:
+ type: string
+ description: The vendor of the application.
+ application-version:
+ type: string
+ description: The version of the application.
+ selflink:
+ type: string
+ description: URL to endpoint where AAI can get more details
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ vnf-images:
+ description: |
+ Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge.
+ properties:
+ vnf-image:
+ type: array
+ items:
+ $ref: "#/definitions/vnf-image"
+ vnfc:
+ description: |
+ ###### Related Nodes
+ - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - TO instance-group( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO vip-ipv4-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
+ - TO vip-ipv6-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
+ - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
+ - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
+ - VNFC is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
+ required:
+ - vnfc-name
+ - nfc-naming-code
+ - nfc-function
+ - in-maint
+ - is-closed-loop-disabled
+ properties:
+ vnfc-name:
+ type: string
+ description: Unique ID of vnfc.
+ nfc-naming-code:
+ type: string
+ description: Short code that is used in naming instances of the item being modeled
+ nfc-function:
+ type: string
+ description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
+ prov-status:
+ type: string
+ description: prov status of this vnfc
+ orchestration-status:
+ type: string
+ description: Orchestration status of this VNF, mastered by APP-C
+ ipaddress-v4-oam-vip:
+ type: string
+ description: Oam V4 vip address of this vnfc
+ in-maint:
+ type: boolean
+ is-closed-loop-disabled:
+ type: boolean
+ group-notation:
+ type: string
+ description: Group notation of VNFC
+ model-invariant-id:
+ type: string
+ description: the ASDC model id for this resource or service model.
+ model-version-id:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ l3-interface-ipv4-address-list:
+ type: array
+ items:
+ $ref: "#/definitions/l3-interface-ipv4-address-list"
+ l3-interface-ipv6-address-list:
+ type: array
+ items:
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
+ vnfcs:
+ description: |
+ virtual network components associated with a vserver from application controller.
+ properties:
+ vnfc:
+ type: array
+ items:
+ $ref: "#/definitions/vnfc"
+ volume:
+ description: |
+ Ephemeral Block storage volume.
+ ###### Related Nodes
+ - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume)
+ required:
+ - volume-id
+ - volume-selflink
+ properties:
+ volume-id:
+ type: string
+ description: Unique ID of block storage volume relative to the vserver.
+ volume-selflink:
+ type: string
+ description: URL to endpoint where AAI can get more details
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ volume-group:
+ description: |
+ Persistent block-level storage.
+ ###### Related Nodes
+ - TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
+ - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
+ - FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
+ required:
+ - volume-group-id
+ - volume-group-name
+ - vnf-type
+ properties:
+ volume-group-id:
+ type: string
+ description: Unique ID of volume-group.
+ volume-group-name:
+ type: string
+ description: Name of the volume group.
+ heat-stack-id:
+ type: string
+ description: Heat stack id corresponding to this volume-group
+ vnf-type:
+ type: string
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ orchestration-status:
+ type: string
+ description: Orchestration status of this volume-group
+ model-customization-id:
+ type: string
+ description: captures the id of all the configuration used to customize the resource for the service.
+ vf-module-model-customization-id:
+ type: string
+ description: helps relate the volume group to the vf-module whose components will require the volume group
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ volume-groups:
+ description: |
+ Collection of persistent block-level storage.
+ properties:
+ volume-group:
+ type: array
+ items:
+ $ref: "#/definitions/volume-group"
+ volumes:
+ description: |
+ Collection of ephemeral Block storage volumes.
+ properties:
+ volume:
+ type: array
+ items:
+ $ref: "#/definitions/volume"
+ vpls-pe:
+ description: |
+ VPLS Provider Edge routers.
+ ###### Related Nodes
+ - TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
+ - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
+ - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
+ - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
+ required:
+ - equipment-name
+ properties:
+ equipment-name:
+ type: string
+ prov-status:
+ type: string
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ ipv4-oam-address:
+ type: string
+ description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
+ equipment-role:
+ type: string
+ description: Client should send valid enumerated value, e.g., VPLS-PE.
+ vlan-id-outer:
+ type: integer
+ format: int64
+ description: Temporary location for stag to get to VCE
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ p-interfaces:
+ type: array
+ items:
+ $ref: "#/definitions/p-interface"
+ lag-interfaces:
+ type: array
+ items:
+ $ref: "#/definitions/lag-interface"
+ vpls-pes:
+ description: |
+ Collection of VPLS Provider Edge routers
+ properties:
+ vpls-pe:
+ type: array
+ items:
+ $ref: "#/definitions/vpls-pe"
+ vpn-binding:
+ description: |
+ VPN binding
+ ###### Related Nodes
+ - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY)
+ - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
+ - FROM route-target( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
+ - VPN-BINDING cannot be deleted if linked to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK
+ - VPN-BINDING is DELETED when these are DELETED ROUTE-TARGET
+ required:
+ - vpn-id
+ - vpn-name
+ properties:
+ vpn-id:
+ type: string
+ description: VPN ID, globally unique within A&AI
+ vpn-name:
+ type: string
+ description: VPN Name
+ vpn-platform:
+ type: string
+ description: the platform associated with the VPN example AVPN, Mobility
+ vpn-type:
+ type: string
+ description: Type of the vpn, should be taken from enumerated/valid values
+ vpn-region:
+ type: string
+ description: region of customer vpn
+ customer-vpn-id:
+ type: string
+ description: id for this customer vpn
+ route-distinguisher:
+ type: string
+ description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ route-targets:
+ type: array
+ items:
+ $ref: "#/definitions/route-target"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ description: l3-networks relate to vpn-bindings
+ vpn-bindings:
+ properties:
+ vpn-binding:
+ type: array
+ items:
+ $ref: "#/definitions/vpn-binding"
+ vserver:
+ description: |
+ Virtual Servers, aka virtual machine or VM.
+ ###### Related Nodes
+ - TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
+ - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
+ - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
+ - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
+ - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
+ - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY)
+ - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
+ - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY)
+ - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
+ - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
+ - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
+ - VSERVER is DELETED when these are DELETED L-INTERFACE
+ - VSERVER deletion means associated objects of these types are also DELETED:VOLUME
+ required:
+ - vserver-id
+ - vserver-name
+ - vserver-selflink
+ - in-maint
+ - is-closed-loop-disabled
+ properties:
+ vserver-id:
+ type: string
+ description: Unique identifier for this vserver relative to its tenant
+ vserver-name:
+ type: string
+ description: Name of vserver
+ vserver-name2:
+ type: string
+ description: Alternative name of vserver
+ prov-status:
+ type: string
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ vserver-selflink:
+ type: string
+ description: URL to endpoint where AAI can get more details
+ in-maint:
+ type: boolean
+ is-closed-loop-disabled:
+ type: boolean
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ volumes:
+ type: array
+ items:
+ $ref: "#/definitions/volume"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ l-interfaces:
+ type: array
+ items:
+ $ref: "#/definitions/l-interface"
+ vservers:
+ description: |
+ Collection of virtual Servers, aka virtual machines or VMs.
+ properties:
+ vserver:
+ type: array
+ items:
+ $ref: "#/definitions/vserver"
+ zone:
+ description: |
+ A zone is a grouping of assets in a location homing to the same connections into the CBB
+ ###### Related Nodes
+ - TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
+ - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
+ - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
+ required:
+ - zone-id
+ - zone-name
+ - design-type
+ - zone-context
+ properties:
+ zone-id:
+ type: string
+ description: Code assigned by AIC to the zone
+ zone-name:
+ type: string
+ description: English name associated with the zone
+ design-type:
+ type: string
+ description: Design of zone [Medium/Largeā€¦]
+ zone-context:
+ type: string
+ description: Context of zone [production/test]
+ status:
+ type: string
+ description: Status of a zone.
+ resource-version:
+ type: string
+ description: Concurrency value
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ zones:
+ description: |
+ Collection of zones
+ properties:
+ zone:
+ type: array
+ items:
+ $ref: "#/definitions/zone"
+patchDefinitions:
+ aai-internal:
+ properties:
+ property-name:
+ type: string
+ property-value:
+ type: string
+ action:
+ properties:
+ action-type:
+ type: string
+ action-data:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/action-data"
+ action-data:
+ properties:
+ property-name:
+ type: string
+ property-value:
+ type: string
+ actions:
+ description: |
+ APIs that are more action related than REST (e.g., notify, update).
+ properties:
+ update:
+ type: object
+ $ref: "#/patchDefinitions/update"
+ notify:
+ type: object
+ $ref: "#/patchDefinitions/notify"
+ allotted-resource:
+ description: |
+ Represents a slice or partial piece of a resource that gets separately allotted
+ ###### Related Nodes
+ - TO allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE)
+ - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
+ - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
+ - TO l-interface( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY)
+ - TO network-policy( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
+ - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
+ - TO vpn-binding( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY)
+ - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
+ - TO model-ver( allotted-resource org.onap.relationships.inventory.IsA model-ver, Many2One)
+ - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
+ - FROM configuration( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
+ - FROM allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE)
+ - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT
+ required:
+ - id
+ properties:
+ id:
+ type: string
+ description: Allotted Resource id UUID assigned to this instance.
+ description:
+ type: string
+ description: The descriptive information assigned to this allotted resource instance
+ selflink:
+ type: string
+ description: Link back to more information in the controller
+ model-invariant-id:
+ type: string
+ description: the ASDC model id for this resource or service model.
+ model-version-id:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ persona-model-version:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ allotted-resources:
+ description: |
+ This object is used to store slices of services being offered
+ properties:
+ allotted-resource:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/allotted-resource"
+ availability-zone:
+ description: |
+ Availability zone, a collection of compute hosts/pservers
+ ###### Related Nodes
+ - TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
+ - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
+ - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
+ - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
+ - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
+ - AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
+ required:
+ - availability-zone-name
+ - hypervisor-type
+ properties:
+ availability-zone-name:
+ type: string
+ description: Name of the availability zone. Unique across a cloud region
+ hypervisor-type:
+ type: string
+ description: Type of hypervisor. Source of truth should define valid values.
+ operational-status:
+ type: string
+ description: State that indicates whether the availability zone should be used, etc. Source of truth should define valid values.
+ availability-zones:
+ description: |
+ Collection of availability zones
+ properties:
+ availability-zone:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/availability-zone"
+ az-and-dvs-switches:
+ properties:
+ dvs-switches:
+ type: object
+ $ref: "#/patchDefinitions/dvs-switches"
+ availability-zone:
+ type: object
+ $ref: "#/patchDefinitions/availability-zone"
+ business:
+ description: |
+ Namespace for business related constructs
+ properties:
+ connectors:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/connector"
+ customers:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/customer"
+ lines-of-business:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/line-of-business"
+ owning-entities:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/owning-entity"
+ platforms:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/platform"
+ projects:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/project"
+ class-of-service:
+ description: |
+ ###### Related Nodes
+ - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
+ required:
+ - cos
+ properties:
+ cos:
+ type: string
+ description: unique identifier of probe
+ probe-id:
+ type: string
+ description: identifier of probe
+ probe-type:
+ type: string
+ description: type of probe
+ classes-of-service:
+ description: |
+ class-of-service of probe
+ properties:
+ class-of-service:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/class-of-service"
+ cloud-infrastructure:
+ description: |
+ Namespace for cloud infrastructure.
+ properties:
+ complexes:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/complex"
+ cloud-regions:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/cloud-region"
+ network-profiles:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/network-profile"
+ pservers:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/pserver"
+ virtual-data-centers:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/virtual-data-center"
+ operational-environments:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/operational-environment"
+ cloud-region:
+ description: |
+ cloud-region designates an installation of a cloud cluster or region or instantiation.
+ ###### Related Nodes
+ - TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many)
+ - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
+ - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
+ - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
+ - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
+ - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
+ - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE
+ - CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
+ required:
+ - cloud-owner
+ - cloud-region-id
+ - sriov-automation
+ properties:
+ cloud-owner:
+ type: string
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ cloud-region-id:
+ type: string
+ description: Identifier used by the vendor for the region. Second part of composite key
+ cloud-type:
+ type: string
+ description: Type of the cloud (e.g., openstack)
+ owner-defined-type:
+ type: string
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ cloud-region-version:
+ type: string
+ description: Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
+ identity-url:
+ type: string
+ description: URL of the keystone identity service
+ cloud-zone:
+ type: string
+ description: Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
+ complex-name:
+ type: string
+ description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
+ sriov-automation:
+ type: boolean
+ cloud-extra-info:
+ type: string
+ description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
+ cloud-epa-caps:
+ type: string
+ description: MultiVIM will discover and expose EPA capabilities.
+ cloud-regions:
+ properties:
+ cloud-region:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/cloud-region"
+ complex:
+ description: |
+ Collection of physical locations that can house cloud-regions.
+ ###### Related Nodes
+ - TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
+ - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
+ - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
+ - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
+ - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
+ - COMPLEX is DELETED when these are DELETED CTAG-POOL
+ required:
+ - physical-location-id
+ - physical-location-type
+ - street1
+ - city
+ - postal-code
+ - country
+ - region
+ properties:
+ physical-location-id:
+ type: string
+ description: Unique identifier for physical location, e.g., CLLI
+ data-center-code:
+ type: string
+ description: Data center code which can be an alternate way to identify a complex
+ complex-name:
+ type: string
+ description: Gamma complex name for LCP instance.
+ identity-url:
+ type: string
+ description: URL of the keystone identity service
+ complexes:
+ description: |
+ Collection of physical locations that can house cloud-regions.
+ properties:
+ complex:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/complex"
+ configuration:
+ description: |
+ Port Mirror Configuration.
+ ###### Related Nodes
+ - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
+ - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
+ - TO l-interface( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY)
+ - TO pnf( configuration org.onap.relationships.inventory.AppliesTo pnf, ONE2MANY)
+ - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
+ - FROM forwarder( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
+ - FROM forwarding-path( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
+ - FROM evc( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
+ - FROM forwarder-evc( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
+ - CONFIGURATION is DELETED when these are DELETED METADATUM,EVC,FORWARDER-EVC
+ - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK
+ required:
+ - configuration-id
+ - configuration-type
+ - configuration-sub-type
+ - orchestration-status
+ - operational-status
+ - configuration-selflink
+ - model-customization-id
+ properties:
+ configuration-id:
+ type: string
+ description: UUID assigned to configuration.
+ management-option:
+ type: string
+ description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
+ configuration-name:
+ type: string
+ description: Name of the configuration.
+ configuration-type:
+ type: string
+ description: port-mirroring-configuration.
+ configuration-sub-type:
+ type: string
+ description: vprobe, pprobe.
+ model-invariant-id:
+ type: string
+ description: the ASDC model id for this resource or service model.
+ model-version-id:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ orchestration-status:
+ type: string
+ description: Orchestration status of the configuration.
+ operational-status:
+ type: string
+ description: Indicator for whether the resource is considered operational.
+ configuration-selflink:
+ type: string
+ description: URL to endpoint where AAI can get more details from SDN-GC.
+ model-customization-id:
+ type: string
+ description: id of the configuration used to customize the resource
+ tunnel-bandwidth:
+ type: string
+ description: DHV Site Effective Bandwidth
+ vendor-allowed-max-bandwidth:
+ type: string
+ description: Velocloud Nominal Throughput - VNT
+ configurations:
+ description: |
+ Collection of configurations
+ properties:
+ configuration:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/configuration"
+ connector:
+ description: |
+ Collection of resource instances used to connect a variety of disparate inventory widgets
+ ###### Related Nodes
+ - TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
+ - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
+ - CONNECTOR is DELETED when these are DELETED METADATUM
+ required:
+ - resource-instance-id
+ properties:
+ resource-instance-id:
+ type: string
+ description: Unique id of resource instance.
+ connectors:
+ description: |
+ Collection of resource instances used to connect a variety of disparate inventory widgets
+ properties:
+ connector:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/connector"
+ constrained-element-set:
+ description: |
+ This is how we would capture constraints defining allowed sets of elements.
+ ###### Related Nodes
+ - TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
+ - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
+ - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
+ - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET
+ required:
+ - constrained-element-set-uuid
+ - constraint-type
+ - check-type
+ properties:
+ constrained-element-set-uuid:
+ type: string
+ constraint-type:
+ type: string
+ check-type:
+ type: string
+ constrained-element-sets:
+ properties:
+ constrained-element-set:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/constrained-element-set"
+ ctag-assignment:
+ description: |
+ ###### Related Nodes
+ - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
+ required:
+ - vlan-id-inner
+ properties:
+ vlan-id-inner:
+ type: integer
+ format: int64
+ description: id.
+ ctag-assignments:
+ properties:
+ ctag-assignment:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/ctag-assignment"
+ ctag-pool:
+ description: |
+ A collection of C tags (vlan tags) grouped for a specific purpose.
+ ###### Related Nodes
+ - TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
+ - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
+ - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
+ required:
+ - target-pe
+ - availability-zone-name
+ - ctag-pool-purpose
+ properties:
+ target-pe:
+ type: string
+ description: The Target provider edge router
+ availability-zone-name:
+ type: string
+ description: Name of the availability zone
+ ctag-pool-purpose:
+ type: string
+ description: Describes what the intended purpose of this pool is.
+ ctag-values:
+ type: string
+ description: Comma separated list of ctags
+ ctag-pools:
+ properties:
+ ctag-pool:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/ctag-pool"
+ customer:
+ description: |
+ customer identifiers to provide linkage back to BSS information.
+ ###### Related Nodes
+ - FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
+ - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION
+ required:
+ - global-customer-id
+ - subscriber-name
+ - subscriber-type
+ properties:
+ global-customer-id:
+ type: string
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ subscriber-name:
+ type: string
+ description: Subscriber name, an alternate way to retrieve a customer.
+ subscriber-type:
+ type: string
+ description: Subscriber type, a way to provide VID with only the INFRA customers.
+ customers:
+ description: |
+ Collection of customer identifiers to provide linkage back to BSS information.
+ properties:
+ customer:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/customer"
+ cvlan-tag-entry:
+ required:
+ - cvlan-tag
+ properties:
+ cvlan-tag:
+ type: integer
+ format: int64
+ description: See mis-na-virtualization-platform.yang
+ cvlan-tags:
+ properties:
+ cvlan-tag-entry:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/cvlan-tag-entry"
+ dvs-switch:
+ 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.
+ ###### Related Nodes
+ - TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
+ required:
+ - switch-name
+ - vcenter-url
+ properties:
+ switch-name:
+ type: string
+ description: DVS switch name
+ vcenter-url:
+ type: string
+ description: URL used to reach the vcenter
+ dvs-switches:
+ description: |
+ Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
+ properties:
+ dvs-switch:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/dvs-switch"
+ edge-prop-names:
+ description: |
+ Internal map to define the properties of an edge and interpret the map EdgeRules
+ properties:
+ edgeLabel:
+ type: string
+ direction:
+ type: string
+ multiplicityRule:
+ type: string
+ contains-other-v:
+ type: string
+ delete-other-v:
+ type: string
+ SVC-INFRA:
+ type: string
+ prevent-delete:
+ type: string
+ aai-uuid:
+ type: string
+ edge-tag-query-request:
+ properties:
+ edge-tag:
+ type: string
+ result-detail:
+ type: string
+ start-node-type:
+ type: string
+ start-node-filter:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/start-node-filter"
+ include-node-filter:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/include-node-filter"
+ secondary-filter:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/secondary-filter"
+ edge-tag-query-result:
+ properties:
+ tagged-inventory-item-list:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/tagged-inventory-item-list"
+ element-choice-set:
+ description: |
+ This is how we would capture constraints defining allowed sets of elements.
+ ###### Related Nodes
+ - TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
+ - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
+ - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT
+ required:
+ - element-choice-set-uuid
+ - element-choice-set-name
+ properties:
+ element-choice-set-uuid:
+ type: string
+ element-choice-set-name:
+ type: string
+ cardinality:
+ type: string
+ element-choice-sets:
+ properties:
+ element-choice-set:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/element-choice-set"
+ entitlement:
+ description: |
+ Metadata for entitlement group.
+ ###### Related Nodes
+ - TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
+ required:
+ - group-uuid
+ - resource-uuid
+ properties:
+ group-uuid:
+ type: string
+ description: Unique ID for the entitlement group the resource comes from, should be uuid.
+ resource-uuid:
+ type: string
+ description: Unique ID of an entitlement resource.
+ entitlements:
+ description: |
+ Entitlements, keyed by group-uuid and resource-uuid, related to license management
+ properties:
+ entitlement:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/entitlement"
+ esr-ems:
+ description: |
+ Persist EMS address information used by EMS driver.
+ ###### Related Nodes
+ - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)
+ - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
+ required:
+ - ems-id
+ properties:
+ ems-id:
+ type: string
+ description: Unique ID of EMS.
+ esr-ems-list:
+ properties:
+ esr-ems:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/esr-ems"
+ esr-system-info:
+ description: |
+ Persist common address information of external systems.
+ ###### Related Nodes
+ - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)
+ - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)
+ - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)
+ - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)
+ required:
+ - esr-system-info-id
+ - user-name
+ - password
+ - system-type
+ properties:
+ esr-system-info-id:
+ type: string
+ description: Unique ID of esr system info.
+ system-name:
+ type: string
+ description: name of external system.
+ type:
+ type: string
+ description: type of external systems.
+ vendor:
+ type: string
+ description: vendor of external systems.
+ version:
+ type: string
+ description: version of external systems.
+ service-url:
+ type: string
+ description: url used to access external systems.
+ user-name:
+ type: string
+ description: username used to access external systems.
+ password:
+ type: string
+ description: password used to access external systems.
+ system-type:
+ type: string
+ description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
+ protocol:
+ type: string
+ description: protocol of third party SDNC, for example netconf/snmp.
+ ssl-cacert:
+ type: string
+ description: ca file content if enabled ssl on auth-url.
+ ssl-insecure:
+ type: boolean
+ description: Whether to verify VIM's certificate.
+ ip-address:
+ type: string
+ description: service IP of ftp server.
+ port:
+ type: string
+ description: service port of ftp server.
+ cloud-domain:
+ type: string
+ description: domain info for authentication.
+ default-tenant:
+ type: string
+ description: default tenant of VIM.
+ passive:
+ type: boolean
+ description: ftp passive mode or not.
+ remote-path:
+ type: string
+ description: resource or performance data file path.
+ system-status:
+ type: string
+ description: the status of external system.
+ esr-system-info-list:
+ description: |
+ Collection of persistent block-level external system auth info.
+ properties:
+ esr-system-info:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/esr-system-info"
+ esr-thirdparty-sdnc:
+ description: |
+ Persist SDNC address information used by ONAP SDNC.
+ ###### Related Nodes
+ - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)
+ - TO pnf( esr-thirdparty-sdnc has pnf, One2Many)
+ - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
+ required:
+ - thirdparty-sdnc-id
+ properties:
+ thirdparty-sdnc-id:
+ type: string
+ description: Unique ID of SDNC.
+ location:
+ type: string
+ description: used for DC type to indicate the location of SDNC, such as Core or Edge.
+ product-name:
+ type: string
+ description: password used to access SDNC server.
+ esr-thirdparty-sdnc-list:
+ properties:
+ esr-thirdparty-sdnc:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/esr-thirdparty-sdnc"
+ esr-vnfm:
+ description: |
+ Persist VNFM address information used by VF-C.
+ ###### Related Nodes
+ - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)
+ - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
+ required:
+ - vnfm-id
+ properties:
+ vnfm-id:
+ type: string
+ description: Unique ID of VNFM.
+ vim-id:
+ type: string
+ description: indecate the VIM to deploy VNF.
+ certificate-url:
+ type: string
+ description: certificate url of VNFM.
+ esr-vnfm-list:
+ properties:
+ esr-vnfm:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/esr-vnfm"
+ evc:
+ description: |
+ evc object is an optional child object of the Configuration object.
+ ###### Related Nodes
+ - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
+ required:
+ - evc-id
+ properties:
+ evc-id:
+ type: string
+ description: Unique/key field for the evc object
+ forwarding-path-topology:
+ type: string
+ description: Point-to-Point, Multi-Point
+ cir-value:
+ type: string
+ description: Commited Information Rate
+ cir-units:
+ type: string
+ description: CIR units
+ connection-diversity-group-id:
+ type: string
+ description: Diversity Group ID
+ service-hours:
+ type: string
+ description: formerly Performance Group
+ esp-evc-circuit-id:
+ type: string
+ description: EVC Circuit ID of ESP EVC
+ esp-evc-cir-value:
+ type: string
+ description: Committed Information Rate (For ESP)
+ esp-evc-cir-units:
+ type: string
+ description: CIR units (For ESP)
+ esp-itu-code:
+ type: string
+ description: Identifies ESP
+ collector-pop-clli:
+ type: string
+ description: Collector POP CLLI (from the hostname of the access pnf)
+ inter-connect-type-ingress:
+ type: string
+ description: Interconnect type on ingress side of EVC.
+ tagmode-access-ingress:
+ type: string
+ description: tagode for collector side of EVC
+ tagmode-access-egress:
+ type: string
+ description: tagMode for network side of EVC
+ evcs:
+ properties:
+ evc:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/evc"
+ external-system:
+ description: |
+ Namespace for external system.
+ properties:
+ esr-ems-list:
+ type: object
+ $ref: "#/patchDefinitions/esr-ems-list"
+ esr-vnfm-list:
+ type: object
+ $ref: "#/patchDefinitions/esr-vnfm-list"
+ esr-thirdparty-sdnc-list:
+ type: object
+ $ref: "#/patchDefinitions/esr-thirdparty-sdnc-list"
+ extra-properties:
+ description: |
+ Extra properties for inventory item for response list
+ properties:
+ extra-property:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/extra-property"
+ extra-property:
+ properties:
+ property-name:
+ type: string
+ property-value:
+ type: string
+ flavor:
+ description: |
+ Openstack flavor.
+ ###### Related Nodes
+ - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
+ - FLAVOR cannot be deleted if linked to VSERVER
+ required:
+ - flavor-id
+ - flavor-name
+ - flavor-selflink
+ properties:
+ flavor-id:
+ type: string
+ description: Flavor id, expected to be unique across cloud-region.
+ flavor-name:
+ type: string
+ description: Flavor name
+ flavor-vcpus:
+ type: integer
+ format: int32
+ description: Number of CPUs
+ flavor-ram:
+ type: integer
+ format: int32
+ description: Amount of memory
+ flavor-disk:
+ type: integer
+ format: int32
+ description: Disk space
+ flavor-ephemeral:
+ type: integer
+ format: int32
+ description: Amount of ephemeral disk space
+ flavor-swap:
+ type: string
+ description: amount of swap space allocation
+ flavor-is-public:
+ type: boolean
+ description: whether flavor is available to all users or private to the tenant it was created in.
+ flavor-selflink:
+ type: string
+ description: URL to endpoint where AAI can get more details
+ flavor-disabled:
+ type: boolean
+ description: Boolean as to whether this flavor is no longer enabled
+ flavors:
+ description: |
+ Collection of openstack flavors.
+ properties:
+ flavor:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/flavor"
+ forwarder:
+ description: |
+ Entity describing a sequenced segment of forwarding path
+ ###### Related Nodes
+ - TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
+ - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
+ - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
+ - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
+ - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
+ - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION
+ required:
+ - sequence
+ properties:
+ sequence:
+ type: integer
+ format: int32
+ description: Unique ID of this segmentation
+ forwarder-role:
+ type: string
+ description: ingress, intermediate, egress
+ forwarder-evc:
+ description: |
+ forwarder object is an optional child object of the Configuration object.
+ ###### Related Nodes
+ - TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
+ required:
+ - forwarder-evc-id
+ properties:
+ forwarder-evc-id:
+ type: string
+ description: Key for forwarder-evc object
+ circuit-id:
+ type: string
+ description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
+ ivlan:
+ type: string
+ description: Internal VLAN.
+ svlan:
+ type: string
+ description: SVLAN value for ingress of egress forwarder.
+ cvlan:
+ type: string
+ description: CVLAN value for ingress of egress forwarder.
+ forwarder-evcs:
+ properties:
+ forwarder-evc:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/forwarder-evc"
+ forwarders:
+ properties:
+ forwarder:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/forwarder"
+ forwarding-path:
+ description: |
+ Entity that describes the sequenced forwarding path between interfaces of services or resources
+ ###### Related Nodes
+ - TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
+ - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
+ - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
+ - FORWARDING-PATH is DELETED when these are DELETED FORWARDER
+ - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION
+ required:
+ - forwarding-path-id
+ - forwarding-path-name
+ properties:
+ forwarding-path-id:
+ type: string
+ description: Unique ID of this FP
+ forwarding-path-name:
+ type: string
+ description: Name of the FP
+ forwarding-paths:
+ properties:
+ forwarding-path:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/forwarding-path"
+ generic-vnf:
+ description: |
+ General purpose VNF
+ ###### Related Nodes
+ - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
+ - TO complex( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
+ - TO configuration( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
+ - TO ctag-pool( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
+ - TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
+ - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
+ - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY)
+ - TO pnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY)
+ - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
+ - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
+ - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
+ - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
+ - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
+ - TO model-ver( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One)
+ - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
+ - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
+ - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
+ - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - FROM line-of-business( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
+ - FROM platform( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
+ - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE
+ - GENERIC-VNF deletion means associated objects of these types are also DELETED:CONFIGURATION
+ required:
+ - vnf-id
+ - vnf-instance-id
+ - vnf-name
+ - vnf-type
+ - vnf-package-name
+ - vnf-discriptor-name
+ - job-id
+ - in-maint
+ - is-closed-loop-disabled
+ properties:
+ vnf-id:
+ type: string
+ description: Unique id of VNF. This is unique across the graph.
+ vnf-instance-id:
+ type: string
+ description: vnf instance id.
+ vnf-name:
+ type: string
+ description: Name of VNF.
+ vnf-name2:
+ type: string
+ description: Alternate name of VNF.
+ vnf-type:
+ type: string
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ service-id:
+ type: string
+ description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
+ regional-resource-zone:
+ type: string
+ description: Regional way of organizing pservers, source of truth should define values
+ prov-status:
+ type: string
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ operational-status:
+ type: string
+ description: Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.
+ license-key:
+ type: string
+ description: OBSOLETE - do not use
+ equipment-role:
+ type: string
+ description: Client should send valid enumerated value
+ orchestration-status:
+ type: string
+ description: Orchestration status of this VNF, used by MSO.
+ vnf-package-name:
+ type: string
+ vnf-discriptor-name:
+ type: string
+ description: vnf discriptor name
+ job-id:
+ type: string
+ description: job id corresponding to vnf
+ heat-stack-id:
+ type: string
+ description: Heat stack id corresponding to this instance, managed by MSO
+ mso-catalog-key:
+ type: string
+ description: Corresponds to the SDN-C catalog id used to configure this VCE
+ management-option:
+ type: string
+ description: identifier of managed by ATT or customer
+ ipv4-oam-address:
+ type: string
+ description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
+ ipv4-loopback0-address:
+ type: string
+ description: v4 Loopback0 address
+ nm-lan-v6-address:
+ type: string
+ description: v6 Loopback address
+ management-v6-address:
+ type: string
+ description: v6 management address
+ vcpu:
+ type: integer
+ format: int64
+ description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
+ vcpu-units:
+ type: string
+ description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE
+ vmemory:
+ type: integer
+ format: int64
+ description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
+ vmemory-units:
+ type: string
+ description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE
+ vdisk:
+ type: integer
+ format: int64
+ description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE
+ vdisk-units:
+ type: string
+ description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE
+ nshd:
+ type: integer
+ format: int64
+ description: number of associated SHD in vnf.
+ nvm:
+ type: integer
+ format: int64
+ description: number of vms in vnf.
+ nnet:
+ type: integer
+ format: int64
+ description: number of network in vnf.
+ in-maint:
+ type: boolean
+ is-closed-loop-disabled:
+ type: boolean
+ generic-vnfs:
+ description: |
+ Collection of VNFs
+ properties:
+ generic-vnf:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/generic-vnf"
+ group-assignment:
+ description: |
+ Openstack group-assignment used to store exclusivity groups (EG).
+ ###### Related Nodes
+ - TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
+ - FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
+ required:
+ - group-id
+ - group-type
+ - group-name
+ properties:
+ group-id:
+ type: string
+ description: Group id, expected to be unique across cloud-region.
+ group-type:
+ type: string
+ description: Group type - the type of group this instance refers to
+ group-name:
+ type: string
+ description: Group name - name assigned to the group
+ group-description:
+ type: string
+ description: Group description - description of the group
+ group-assignments:
+ description: |
+ Collection of openstack group assignments
+ properties:
+ group-assignment:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/group-assignment"
+ host-route:
+ description: |
+ ###### Related Nodes
+ - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
+ required:
+ - host-route-id
+ - route-prefix
+ - next-hop
+ properties:
+ host-route-id:
+ type: string
+ description: host-route id
+ route-prefix:
+ type: string
+ description: subnet prefix
+ next-hop:
+ type: string
+ description: Could be ip-address, hostname, or service-instance
+ next-hop-type:
+ type: string
+ description: Should be ip-address, hostname, or service-instance to match next-hop
+ host-routes:
+ properties:
+ host-route:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/host-route"
+ image:
+ description: |
+ Openstack image.
+ ###### Related Nodes
+ - TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
+ - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
+ - IMAGE cannot be deleted if linked to VSERVER
+ - IMAGE is DELETED when these are DELETED METADATUM
+ required:
+ - image-id
+ - image-name
+ - image-os-distro
+ - image-os-version
+ - image-selflink
+ properties:
+ image-id:
+ type: string
+ description: Image id, expected to be unique across cloud region
+ image-name:
+ type: string
+ description: Image name
+ image-architecture:
+ type: string
+ description: Operating system architecture.
+ image-os-distro:
+ type: string
+ description: The common name of the operating system distribution in lowercase
+ image-os-version:
+ type: string
+ description: The operating system version as specified by the distributor.
+ application:
+ type: string
+ description: The application that the image instantiates.
+ application-vendor:
+ type: string
+ description: The vendor of the application.
+ application-version:
+ type: string
+ description: The version of the application.
+ image-selflink:
+ type: string
+ description: URL to endpoint where AAI can get more details
+ images:
+ description: |
+ Collectio of Openstack images.
+ properties:
+ image:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/image"
+ include-node-filter:
+ properties:
+ include-node-type:
+ type: string
+ instance-filter:
+ description: |
+ InstanceFilter for performing a named-query or model query
+ instance-filters:
+ description: |
+ InstanceFilters for performing a named-query or model query
+ properties:
+ instance-filter:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/instance-filter"
+ instance-group:
+ description: |
+ General mechanism for grouping instances
+ ###### Related Nodes
+ - TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
+ - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
+ - FROM l3-network( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - FROM l-interface( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - FROM vnfc( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ required:
+ - instance-group-role
+ - model-invariant-id
+ - model-version-id
+ - id
+ - description
+ - type
+ properties:
+ instance-group-role:
+ type: string
+ description: role of the instance group.
+ model-invariant-id:
+ type: string
+ description: ASDC model id for this resource or service model.
+ model-version-id:
+ type: string
+ description: ASDC model version uid for this resource model.
+ id:
+ type: string
+ description: Instance Group ID, UUID assigned to this instance.
+ description:
+ type: string
+ description: Descriptive text to help identify the usage of this instance-group
+ type:
+ type: string
+ description: Only valid value today is lower case ha for high availability
+ sub-type:
+ type: string
+ description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
+ instance-groups:
+ description: |
+ Collection of openstack route table references
+ properties:
+ instance-group:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/instance-group"
+ inventory:
+ properties:
+ search:
+ type: object
+ $ref: "#/patchDefinitions/search"
+ actions:
+ type: object
+ $ref: "#/patchDefinitions/actions"
+ cloud-infrastructure:
+ type: object
+ $ref: "#/patchDefinitions/cloud-infrastructure"
+ external-system:
+ type: object
+ $ref: "#/patchDefinitions/external-system"
+ business:
+ type: object
+ $ref: "#/patchDefinitions/business"
+ service-design-and-creation:
+ type: object
+ $ref: "#/patchDefinitions/service-design-and-creation"
+ network:
+ type: object
+ $ref: "#/patchDefinitions/network"
+ aai-internal:
+ type: object
+ $ref: "#/patchDefinitions/aai-internal"
+ nodes:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/aai-internal"
+ inventory-item:
+ properties:
+ inventory-item-type:
+ type: string
+ inventory-item-link:
+ type: string
+ inventory-item-data:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/inventory-item-data"
+ tagged-inventory-item-list:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/tagged-inventory-item-list"
+ inventory-item-data:
+ properties:
+ property-name:
+ type: string
+ property-value:
+ type: string
+ inventory-response-item:
+ description: |
+ Inventory item for response list
+ properties:
+ model-name:
+ type: string
+ extra-properties:
+ type: object
+ $ref: "#/patchDefinitions/extra-properties"
+ inventory-response-items:
+ type: object
+ $ref: "#/patchDefinitions/inventory-response-items"
+ inventory-response-items:
+ description: |
+ Container for inventory items in response list
+ properties:
+ inventory-response-item:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/inventory-response-item"
+ ipsec-configuration:
+ 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
+ ###### Related Nodes
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
+ - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
+ - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER
+ required:
+ - ipsec-configuration-id
+ properties:
+ ipsec-configuration-id:
+ type: string
+ description: UUID of this configuration
+ requested-vig-address-type:
+ type: string
+ description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
+ requested-encryption-strength:
+ type: string
+ description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
+ requested-dmz-type:
+ type: string
+ description: ATT can offer a shared DMZ or a DMZ specific to a customer
+ shared-dmz-network-address:
+ type: string
+ description: Network address of shared DMZ
+ requested-customer-name:
+ type: string
+ description: If the DMZ is a custom DMZ, this field will indicate the customer information
+ ike-version:
+ type: string
+ description: can be 1 or 2
+ ikev1-authentication:
+ type: string
+ description: Contains values like md5, sha1, sha256, sha384
+ ikev1-encryption:
+ type: string
+ description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,ƂĀ aes-192-cbc, aes-265-cbc
+ ikev1-dh-group:
+ type: string
+ description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
+ ikev1-am-group-id:
+ type: string
+ description: Group name defined in VIG for clients using aggressive mode
+ ikev1-am-password:
+ type: string
+ description: pre-shared key for the above group name
+ ikev1-sa-lifetime:
+ type: string
+ description: Lifetime for IKEv1 SA
+ ipsec-authentication:
+ type: string
+ description: md5, sha1, sha256, sha384
+ ipsec-encryption:
+ type: string
+ description: 3des-cbc, des-cbc, aes-128-cbc,ƂĀ aes-192-cbc, aes-265-cbc
+ ipsec-sa-lifetime:
+ type: string
+ description: Life time for IPSec SA
+ ipsec-pfs:
+ type: string
+ description: enable PFS or not
+ xauth-userid:
+ type: string
+ description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName
+ xauth-user-password:
+ type: string
+ description: Encrypted using the Juniper $9$ algorithm
+ dpd-interval:
+ type: string
+ description: The time between DPD probe
+ dpd-frequency:
+ type: string
+ description: Maximum number of DPD before claiming the tunnel is down
+ ipsec-configurations:
+ properties:
+ ipsec-configuration:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/ipsec-configuration"
+ key-data:
+ properties:
+ key-name:
+ type: string
+ key-value:
+ type: string
+ l-interface:
+ description: |
+ Logical interfaces, e.g., a vnic.
+ ###### Related Nodes
+ - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
+ - TO instance-group( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
+ - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
+ - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
+ - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
+ - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
+ - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY)
+ - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
+ - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
+ - FROM configuration( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY)
+ - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
+ - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
+ - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,LOGICAL-LINK,SRIOV-VF,VLAN
+ - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
+ required:
+ - interface-name
+ - is-port-mirrored
+ - in-maint
+ - is-ip-unnumbered
+ properties:
+ interface-name:
+ type: string
+ description: Name given to the interface
+ interface-role:
+ type: string
+ description: E.g., CUSTOMER, UPLINK, etc.
+ v6-wan-link-ip:
+ type: string
+ description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
+ selflink:
+ type: string
+ description: URL to endpoint where AAI can get more details
+ interface-id:
+ type: string
+ description: ID of interface
+ macaddr:
+ type: string
+ description: MAC address for the interface
+ network-name:
+ type: string
+ description: Name of the network
+ management-option:
+ type: string
+ description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
+ interface-description:
+ type: string
+ description: Human friendly text regarding this interface.
+ is-port-mirrored:
+ type: boolean
+ l-interfaces:
+ description: |
+ Collection of logical interfaces.
+ properties:
+ l-interface:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/l-interface"
+ l3-interface-ipv4-address-list:
+ description: |
+ IPv4 Address Range
+ ###### Related Nodes
+ - TO instance-group( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
+ - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
+ - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
+ - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
+ - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
+ - TO vnfc( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
+ required:
+ - l3-interface-ipv4-address
+ properties:
+ l3-interface-ipv4-address:
+ type: string
+ description: IP address
+ l3-interface-ipv4-prefix-length:
+ type: integer
+ format: int64
+ description: Prefix length, 32 for single address
+ vlan-id-inner:
+ type: integer
+ format: int64
+ description: Inner VLAN tag
+ vlan-id-outer:
+ type: integer
+ format: int64
+ description: Outer VLAN tag
+ is-floating:
+ type: boolean
+ description: Indicator of fixed or floating address
+ l3-interface-ipv6-address-list:
+ description: |
+ IPv6 Address Range
+ ###### Related Nodes
+ - TO instance-group( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
+ - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
+ - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
+ - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
+ - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
+ - TO vnfc( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
+ required:
+ - l3-interface-ipv6-address
+ properties:
+ l3-interface-ipv6-address:
+ type: string
+ description: IP address
+ l3-interface-ipv6-prefix-length:
+ type: integer
+ format: int64
+ description: Prefix length, 128 for single address
+ vlan-id-inner:
+ type: integer
+ format: int64
+ description: Inner VLAN tag
+ vlan-id-outer:
+ type: integer
+ format: int64
+ description: Outer VLAN tag
+ is-floating:
+ type: boolean
+ description: Indicator of fixed or floating address
+ l3-network:
+ description: |
+ Generic network definition
+ ###### Related Nodes
+ - TO instance-group( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
+ - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
+ - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
+ - TO model-ver( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One)
+ - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
+ - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
+ - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
+ - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
+ - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
+ - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
+ - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
+ - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
+ - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET
+ required:
+ - network-id
+ - network-name
+ - is-bound-to-vpn
+ - is-provider-network
+ - is-shared-network
+ - is-external-network
+ properties:
+ network-id:
+ type: string
+ description: Network ID, should be uuid. Unique across A&AI.
+ network-name:
+ type: string
+ description: Name of the network, governed by some naming convention..
+ network-type:
+ type: string
+ description: Type of the network - who defines these values?
+ network-role:
+ type: string
+ description: Role the network plans - who defines these values?
+ network-technology:
+ type: string
+ description: Network technology - who defines these values?
+ neutron-network-id:
+ type: string
+ description: Neutron network id of this Interface
+ is-bound-to-vpn:
+ type: boolean
+ service-id:
+ type: string
+ description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
+ network-role-instance:
+ type: integer
+ format: int64
+ description: network role instance
+ l3-networks:
+ properties:
+ l3-network:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/l3-network"
+ lag-interface:
+ description: |
+ Link aggregate interface
+ ###### Related Nodes
+ - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
+ - TO logical-link( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
+ - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
+ - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
+ - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
+ - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
+ - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
+ - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
+ - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE
+ - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK
+ required:
+ - interface-name
+ - in-maint
+ properties:
+ interface-name:
+ type: string
+ description: Name that identifies the link aggregate interface
+ interface-description:
+ type: string
+ description: Human friendly text regarding this interface.
+ lag-interfaces:
+ description: |
+ Collection of link aggregate interfaces.
+ properties:
+ lag-interface:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/lag-interface"
+ lag-link:
+ description: |
+ LAG links can connect lag-interfaces
+ ###### Related Nodes
+ - FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
+ required:
+ - link-name
+ properties:
+ link-name:
+ type: string
+ description: Alphabetical concatenation of lag-interface names
+ lag-links:
+ description: |
+ Collection of link aggregation connections
+ properties:
+ lag-link:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/lag-link"
+ license:
+ description: |
+ Metadata for license group.
+ ###### Related Nodes
+ - TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
+ required:
+ - group-uuid
+ - resource-uuid
+ properties:
+ group-uuid:
+ type: string
+ description: Unique ID for the license group the resource belongs to, should be uuid.
+ resource-uuid:
+ type: string
+ description: Unique ID of a license resource.
+ licenses:
+ description: |
+ Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
+ properties:
+ license:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/license"
+ line-of-business:
+ description: |
+ describes a line-of-business
+ ###### Related Nodes
+ - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
+ required:
+ - line-of-business-name
+ properties:
+ line-of-business-name:
+ type: string
+ description: Name of the line-of-business (product)
+ lines-of-business:
+ description: |
+ Collection of lines-of-business
+ properties:
+ line-of-business:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/line-of-business"
+ logical-link:
+ description: |
+ Logical links generally connect l-interfaces but are used to express logical connectivity between two points
+ ###### Related Nodes
+ - TO l-interface( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY)
+ - TO l-interface( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY)
+ - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
+ - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
+ - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
+ - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
+ - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
+ - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
+ - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
+ - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
+ - TO model-ver( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One)
+ - FROM configuration( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
+ - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
+ - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
+ - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
+ - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
+ required:
+ - link-name
+ - in-maint
+ - link-type
+ properties:
+ link-name:
+ type: string
+ description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
+ in-maint:
+ type: boolean
+ link-type:
+ type: string
+ description: Type of logical link, e.g., evc
+ speed-value:
+ type: string
+ description: Captures the numeric part of the speed
+ speed-units:
+ type: string
+ description: Captures the units corresponding to the speed
+ ip-version:
+ type: string
+ description: v4, v6, or ds for dual stack
+ routing-protocol:
+ type: string
+ description: For example, static or BGP
+ logical-links:
+ description: |
+ Collection of logical connections
+ properties:
+ logical-link:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/logical-link"
+ metadata:
+ description: |
+ Collection of metadatum (key/value pairs)
+ properties:
+ metadatum:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/metadatum"
+ metadatum:
+ description: |
+ Key/value pairs
+ ###### Related Nodes
+ - TO configuration( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
+ - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
+ - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
+ - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
+ - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
+ required:
+ - metaname
+ - metaval
+ properties:
+ metaname:
+ type: string
+ metaval:
+ type: string
+ model:
+ description: |
+ Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
+ ###### Related Nodes
+ - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
+ - FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
+ - FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
+ - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
+ - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
+ - MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
+ - MODEL is DELETED when these are DELETED MODEL-VER
+ required:
+ - model-invariant-id
+ - model-type
+ properties:
+ model-invariant-id:
+ type: string
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ model-type:
+ type: string
+ description: Type of the model, e.g., service, resource, widget, etc.
+ model-and-named-query-search:
+ description: |
+ ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
+ properties:
+ query-parameters:
+ type: object
+ $ref: "#/patchDefinitions/query-parameters"
+ instance-filters:
+ type: object
+ $ref: "#/patchDefinitions/instance-filters"
+ secondary-filts:
+ type: object
+ $ref: "#/patchDefinitions/secondary-filts"
+ top-node-type:
+ type: string
+ secondary-filter-cut-point:
+ type: string
+ model-constraint:
+ description: |
+ This is how we would capture constraints defining allowed sets of elements.
+ ###### Related Nodes
+ - TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
+ - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
+ - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET
+ required:
+ - model-constraint-uuid
+ - constrained-element-set-uuid-to-replace
+ properties:
+ model-constraint-uuid:
+ type: string
+ constrained-element-set-uuid-to-replace:
+ type: string
+ constrained-element-sets:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/constrained-element-set"
+ model-constraints:
+ properties:
+ model-constraint:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/model-constraint"
+ model-element:
+ description: |
+ Defines how other models combine to make up a higher-level model.
+ ###### Related Nodes
+ - TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
+ - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
+ - TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
+ - TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
+ - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
+ - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
+ - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
+ - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT
+ required:
+ - model-element-uuid
+ - new-data-del-flag
+ - cardinality
+ properties:
+ model-element-uuid:
+ type: string
+ new-data-del-flag:
+ type: string
+ description: Indicates whether this element was created as part of instantiation from this model
+ cardinality:
+ type: string
+ description: How many of this type of element are required/allowed
+ linkage-points:
+ type: string
+ model-elements:
+ properties:
+ model-element:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/model-element"
+ model-ver:
+ description: |
+ Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
+ ###### Related Nodes
+ - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
+ - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
+ - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
+ - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
+ - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.IsA model-ver, Many2One)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One)
+ - FROM l3-network( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One)
+ - FROM vf-module( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One)
+ - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT
+ - MODEL-VER is DELETED when these are DELETED METADATUM,MODEL-ELEMENT
+ required:
+ - model-version-id
+ - model-name
+ - model-version
+ properties:
+ model-version-id:
+ type: string
+ description: Unique identifier corresponding to one version of a model in ASDC
+ model-name:
+ type: string
+ description: Name of the model, which can change from version to version.
+ model-version:
+ type: string
+ description: Version
+ distribution-status:
+ type: string
+ description: Distribution Status
+ model-description:
+ type: string
+ description: Description
+ model-vers:
+ properties:
+ model-ver:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/model-ver"
+ models:
+ description: |
+ Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
+ properties:
+ model:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/model"
+ multicast-configuration:
+ description: |
+ ###### Related Nodes
+ - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
+ required:
+ - multicast-configuration-id
+ - multicast-protocol
+ - rp-type
+ properties:
+ multicast-configuration-id:
+ type: string
+ description: Unique id of multicast configuration.
+ multicast-protocol:
+ type: string
+ description: protocol of multicast configuration
+ rp-type:
+ type: string
+ description: rp type of multicast configuration
+ multicast-configurations:
+ description: |
+ multicast configuration of generic-vnf ip-address
+ properties:
+ multicast-configuration:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/multicast-configuration"
+ named-queries:
+ properties:
+ named-query:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/named-query"
+ named-query:
+ description: |
+ TBD
+ ###### Related Nodes
+ - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
+ - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
+ - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
+ - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT
+ required:
+ - named-query-uuid
+ - named-query-name
+ - named-query-version
+ properties:
+ named-query-uuid:
+ type: string
+ named-query-name:
+ type: string
+ named-query-version:
+ type: string
+ required-input-param:
+ type: string
+ description:
+ type: string
+ named-query-element:
+ description: |
+ TBD
+ ###### Related Nodes
+ - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
+ - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
+ - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
+ - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
+ - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
+ - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
+ - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP
+ required:
+ - named-query-element-uuid
+ properties:
+ named-query-element-uuid:
+ type: string
+ property-collect-list:
+ type: string
+ named-query-elements:
+ properties:
+ named-query-element:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/named-query-element"
+ network:
+ description: |
+ Namespace for network inventory resources.
+ properties:
+ logical-links:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/logical-link"
+ site-pair-sets:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/site-pair-set"
+ vpn-bindings:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/vpn-binding"
+ vpls-pes:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/vpls-pe"
+ multicast-configurations:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/multicast-configuration"
+ vces:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/vce"
+ vnfcs:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/vnfc"
+ l3-networks:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/l3-network"
+ network-policies:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/network-policy"
+ generic-vnfs:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/generic-vnf"
+ lag-links:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/lag-link"
+ newvces:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/newvce"
+ pnfs:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/pnf"
+ physical-links:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/physical-link"
+ ipsec-configurations:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/ipsec-configuration"
+ route-table-references:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/route-table-reference"
+ instance-groups:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/instance-group"
+ zones:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/zone"
+ configurations:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/configuration"
+ forwarding-paths:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/forwarding-path"
+ network-policies:
+ properties:
+ network-policy:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/network-policy"
+ network-policy:
+ description: |
+ ###### Related Nodes
+ - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
+ - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
+ required:
+ - network-policy-id
+ properties:
+ network-policy-id:
+ type: string
+ description: UUID representing unique key to this instance
+ network-policy-fqdn:
+ type: string
+ description: Contrail FQDN for the policy
+ heat-stack-id:
+ type: string
+ description: ID for the openStack Heat instance
+ network-profile:
+ description: |
+ Network profile populated by SDN-GP for SNMP
+ ###### Related Nodes
+ - TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
+ required:
+ - nm-profile-name
+ properties:
+ nm-profile-name:
+ type: string
+ description: Unique name of network profile.
+ community-string:
+ type: string
+ description: Encrypted SNMP community string
+ network-profiles:
+ description: |
+ Collection of network profiles
+ properties:
+ network-profile:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/network-profile"
+ newvce:
+ description: |
+ This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
+ ###### Related Nodes
+ - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
+ - NEWVCE is DELETED when these are DELETED L-INTERFACE
+ required:
+ - vnf-id2
+ - vnf-name
+ - vnf-type
+ properties:
+ vnf-id2:
+ type: string
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ vnf-name:
+ type: string
+ description: Name of VNF.
+ vnf-name2:
+ type: string
+ description: Alternate name of VNF.
+ vnf-type:
+ type: string
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ prov-status:
+ type: string
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ operational-status:
+ type: string
+ description: Indicator for whether the resource is considered operational
+ license-key:
+ type: string
+ description: OBSOLETE - do not use
+ ipv4-oam-address:
+ type: string
+ description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
+ equipment-role:
+ type: string
+ description: Client should send valid enumerated value.
+ newvces:
+ description: |
+ This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
+ properties:
+ newvce:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/newvce"
+ notification-event:
+ properties:
+ cambria.partition:
+ type: string
+ notification-event-header:
+ type: object
+ $ref: "#/patchDefinitions/notification-event-header"
+ notification-event-header:
+ properties:
+ id:
+ type: string
+ timestamp:
+ type: string
+ source-name:
+ type: string
+ domain:
+ type: string
+ sequence-number:
+ type: string
+ severity:
+ type: string
+ event-type:
+ type: string
+ version:
+ type: string
+ action:
+ type: string
+ entity-type:
+ type: string
+ top-entity-type:
+ type: string
+ entity-link:
+ type: string
+ status:
+ type: string
+ notify:
+ required:
+ - event-id
+ properties:
+ event-id:
+ type: string
+ node-type:
+ type: string
+ event-trigger:
+ type: string
+ key-data:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/key-data"
+ selflink:
+ type: string
+ oam-network:
+ description: |
+ OAM network, to be deprecated shortly. Do not use for new purposes.
+ ###### Related Nodes
+ - TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
+ - TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
+ required:
+ - network-uuid
+ - network-name
+ - cvlan-tag
+ properties:
+ network-uuid:
+ type: string
+ description: UUID of the network. Unique across a cloud-region
+ network-name:
+ type: string
+ description: Name of the network.
+ cvlan-tag:
+ type: integer
+ format: int64
+ description: cvlan-id
+ ipv4-oam-gateway-address:
+ type: string
+ description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
+ ipv4-oam-gateway-address-prefix-length:
+ type: integer
+ format: int32
+ description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
+ oam-networks:
+ description: |
+ Collection of OAM networks, to be deprecated shortly. Do not use for new purposes.
+ properties:
+ oam-network:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/oam-network"
+ operational-environment:
+ description: |
+ It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
+ ###### Related Nodes
+ - TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
+ - FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
+ required:
+ - operational-environment-id
+ - operational-environment-name
+ - operational-environment-type
+ - operational-environment-status
+ - tenant-context
+ - workload-context
+ properties:
+ operational-environment-id:
+ type: string
+ description: UUID of an operational environment
+ operational-environment-name:
+ type: string
+ description: Operational Environment name
+ operational-environment-type:
+ type: string
+ description: Operational Environment Type.
+ operational-environment-status:
+ type: string
+ description: Status
+ tenant-context:
+ type: string
+ description: Tenant Context.
+ workload-context:
+ type: string
+ description: Workload Context.
+ operational-environments:
+ description: |
+ a logical partition of the cloud which allows to have multiple environments in the production AIC.
+ properties:
+ operational-environment:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/operational-environment"
+ overloaded-model:
+ description: |
+ Allows for legacy POST of old-style and new-style models
+ required:
+ - model-invariant-id
+ - model-name-version-id
+ - model-type
+ - model-name
+ - model-id
+ - model-version
+ properties:
+ model-invariant-id:
+ type: string
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ model-name-version-id:
+ type: string
+ description: Unique identifier corresponding to one version of a model in ASDC
+ model-type:
+ type: string
+ description: Type of the model, e.g., service, resource, widget, etc.
+ model-name:
+ type: string
+ description: Name of the model, which can change from version to version.
+ model-id:
+ type: string
+ description: Invariant unique ID which does not change from version to version
+ model-version:
+ type: string
+ description: Version
+ model-description:
+ type: string
+ description: Description
+ owning-entities:
+ description: |
+ Collection of owning-entities
+ properties:
+ owning-entity:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/owning-entity"
+ owning-entity:
+ description: |
+ describes an owning-entity
+ ###### Related Nodes
+ - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
+ required:
+ - owning-entity-id
+ - owning-entity-name
+ properties:
+ owning-entity-id:
+ type: string
+ description: UUID of an owning entity
+ owning-entity-name:
+ type: string
+ description: Owning entity name
+ p-interface:
+ description: |
+ Physical interface (e.g., nic)
+ ###### Related Nodes
+ - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
+ - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
+ - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
+ - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
+ - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
+ - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
+ - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
+ - FROM sriov-pf( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
+ - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
+ - P-INTERFACE is DELETED when these are DELETED L-INTERFACE,SRIOV-PF
+ - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK
+ required:
+ - interface-name
+ - in-maint
+ properties:
+ interface-name:
+ type: string
+ description: Name that identifies the physical interface
+ selflink:
+ type: string
+ description: URL to endpoint where AAI can get more details.
+ speed-value:
+ type: string
+ description: Captures the numeric part of the speed
+ speed-units:
+ type: string
+ description: Captures the units corresponding to the speed
+ port-description:
+ type: string
+ description: Nature of the services and connectivity on this port.
+ equipment-identifier:
+ type: string
+ description: CLEI or other specification for p-interface hardware.
+ interface-role:
+ type: string
+ description: Role specification for p-interface hardware.
+ interface-type:
+ type: string
+ description: Indicates the physical properties of the interface.
+ prov-status:
+ type: string
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ mac-addresss:
+ type: string
+ description: MAC Address of the p-interface.
+ p-interfaces:
+ description: |
+ Collection of physical interfaces.
+ properties:
+ p-interface:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/p-interface"
+ physical-link:
+ description: |
+ Collection of physical connections, typically between p-interfaces
+ ###### Related Nodes
+ - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
+ required:
+ - link-name
+ properties:
+ link-name:
+ type: string
+ description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
+ speed-value:
+ type: string
+ description: Captures the numeric part of the speed
+ speed-units:
+ type: string
+ description: Captures the units corresponding to the speed
+ circuit-id:
+ type: string
+ description: Circuit it
+ dual-mode:
+ type: string
+ description: Dual access mode (e.g., primary, secondary
+ management-option:
+ type: string
+ description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
+ service-provider-name:
+ type: string
+ description: Name of the service Provider on this link.
+ service-provider-bandwidth-up-value:
+ type: integer
+ format: int32
+ description: Upstream Bandwidth value agreed with the service provider
+ service-provider-bandwidth-up-units:
+ type: string
+ description: Units for the upstream BW value
+ service-provider-bandwidth-down-value:
+ type: integer
+ format: int32
+ description: Downstream Bandwidth value agreed with the service provider
+ service-provider-bandwidth-down-units:
+ type: string
+ description: Units for downstream BW value
+ physical-links:
+ description: |
+ Collection of physical connections, typically between p-interfaces
+ properties:
+ physical-link:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/physical-link"
+ platform:
+ description: |
+ describes a platform
+ ###### Related Nodes
+ - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
+ required:
+ - platform-name
+ properties:
+ platform-name:
+ type: string
+ description: Name of the platform
+ platforms:
+ description: |
+ Collection of platforms
+ properties:
+ platform:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/platform"
+ pnf:
+ 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.
+ ###### Related Nodes
+ - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
+ - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc has pnf, One2Many)
+ - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
+ - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
+ - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
+ - FROM configuration( configuration org.onap.relationships.inventory.AppliesTo pnf, ONE2MANY)
+ - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
+ required:
+ - pnf-name
+ - in-maint
+ properties:
+ pnf-name:
+ type: string
+ description: unique name of Physical Network Function.
+ pnf-name2:
+ type: string
+ description: name of Physical Network Function.
+ selflink:
+ type: string
+ description: URL to endpoint where AAI can get more details.
+ pnf-name2-source:
+ type: string
+ description: source of name2
+ pnf-id:
+ type: string
+ description: id of pnf
+ equip-type:
+ type: string
+ description: Equipment type. Source of truth should define valid values.
+ equip-vendor:
+ type: string
+ description: Equipment vendor. Source of truth should define valid values.
+ equip-model:
+ type: string
+ description: Equipment model. Source of truth should define valid values.
+ management-option:
+ type: string
+ description: identifier of managed by ATT or customer
+ ipaddress-v4-oam:
+ type: string
+ description: ipv4-oam-address with new naming convention for IP addresses
+ sw-version:
+ type: string
+ description: sw-version is the version of SW for the hosted application on the PNF.
+ in-maint:
+ type: boolean
+ frame-id:
+ type: string
+ description: ID of the physical frame (relay rack) where pnf is installed.
+ serial-number:
+ type: string
+ description: Serial number of the device
+ ipaddress-v4-loopback-0:
+ type: string
+ description: IPV4 Loopback 0 address
+ ipaddress-v6-loopback-0:
+ type: string
+ description: IPV6 Loopback 0 address
+ ipaddress-v4-aim:
+ type: string
+ description: IPV4 AIM address
+ ipaddress-v6-aim:
+ type: string
+ description: IPV6 AIM address
+ ipaddress-v6-oam:
+ type: string
+ description: IPV6 OAM address
+ inv-status:
+ type: string
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ pnfs:
+ description: |
+ Collection of Physical Network Functions.
+ properties:
+ pnf:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/pnf"
+ port-group:
+ description: |
+ Used to capture the network interfaces of this VCE
+ ###### Related Nodes
+ - TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
+ - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE)
+ - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG
+ required:
+ - interface-id
+ - orchestration-status
+ properties:
+ interface-id:
+ type: string
+ description: Unique ID of the interface
+ neutron-network-id:
+ type: string
+ description: Neutron network id of this Interface
+ neutron-network-name:
+ type: string
+ description: Neutron network name of this Interface
+ interface-role:
+ type: string
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ port-groups:
+ properties:
+ port-group:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/port-group"
+ project:
+ description: |
+ describes the project
+ ###### Related Nodes
+ - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
+ required:
+ - project-name
+ properties:
+ project-name:
+ type: string
+ description: Name of the project deploying a service
+ projects:
+ description: |
+ Collection of projects
+ properties:
+ project:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/project"
+ properties:
+ description: |
+ Property holder for query properties or instance properties
+ properties:
+ property-name:
+ type: string
+ property-value:
+ type: string
+ property-constraint:
+ description: |
+ TBD
+ ###### Related Nodes
+ - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
+ required:
+ - property-constraint-uuid
+ - constraint-type
+ - property-name
+ - property-value
+ properties:
+ property-constraint-uuid:
+ type: string
+ constraint-type:
+ type: string
+ property-name:
+ type: string
+ property-value:
+ type: string
+ property-constraints:
+ properties:
+ property-constraint:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/property-constraint"
+ pserver:
+ description: |
+ Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
+ ###### Related Nodes
+ - TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
+ - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
+ - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
+ - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
+ - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
+ - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
+ - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
+ - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
+ - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER
+ - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
+ - PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT
+ required:
+ - hostname
+ - in-maint
+ properties:
+ hostname:
+ type: string
+ description: Value from executing hostname on the compute node.
+ ptnii-equip-name:
+ type: string
+ description: PTNII name
+ number-of-cpus:
+ type: integer
+ format: int32
+ description: Number of cpus
+ disk-in-gigabytes:
+ type: integer
+ format: int32
+ description: Disk size, in GBs
+ ram-in-megabytes:
+ type: integer
+ format: int32
+ description: RAM size, in MBs
+ equip-type:
+ type: string
+ description: Equipment type. Source of truth should define valid values.
+ equip-vendor:
+ type: string
+ description: Equipment vendor. Source of truth should define valid values.
+ equip-model:
+ type: string
+ description: Equipment model. Source of truth should define valid values.
+ fqdn:
+ type: string
+ description: Fully-qualified domain name
+ pserver-selflink:
+ type: string
+ description: URL to endpoint where AAI can get more details
+ ipv4-oam-address:
+ type: string
+ description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
+ serial-number:
+ type: string
+ description: Serial number, may be queried
+ ipaddress-v4-loopback-0:
+ type: string
+ description: IPV4 Loopback 0 address
+ ipaddress-v6-loopback-0:
+ type: string
+ description: IPV6 Loopback 0 address
+ ipaddress-v4-aim:
+ type: string
+ description: IPV4 AIM address
+ ipaddress-v6-aim:
+ type: string
+ description: IPV6 AIM address
+ ipaddress-v6-oam:
+ type: string
+ description: IPV6 OAM address
+ inv-status:
+ type: string
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ pserver-id:
+ type: string
+ description: ID of Pserver
+ internet-topology:
+ type: string
+ description: internet topology of Pserver
+ in-maint:
+ type: boolean
+ pservers:
+ description: |
+ Collection of compute hosts.
+ properties:
+ pserver:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/pserver"
+ query-parameters:
+ description: |
+ QueryParameters for performing a named-query or model query
+ properties:
+ named-query:
+ type: object
+ $ref: "#/patchDefinitions/named-query"
+ overloaded-model:
+ type: object
+ $ref: "#/patchDefinitions/overloaded-model"
+ related-lookup:
+ description: |
+ TBD
+ ###### Related Nodes
+ - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
+ required:
+ - related-lookup-uuid
+ - source-node-type
+ - source-node-property
+ - target-node-type
+ - target-node-property
+ properties:
+ related-lookup-uuid:
+ type: string
+ source-node-type:
+ type: string
+ source-node-property:
+ type: string
+ target-node-type:
+ type: string
+ target-node-property:
+ type: string
+ property-collect-list:
+ type: string
+ related-lookups:
+ properties:
+ related-lookup:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/related-lookup"
+ related-to-property:
+ properties:
+ property-key:
+ type: string
+ description: Key part of a key/value pair
+ property-value:
+ type: string
+ description: Value part of a key/value pair
+ relationship:
+ properties:
+ related-to:
+ type: string
+ description: A keyword provided by A&AI to indicate type of node.
+ relationship-label:
+ type: string
+ description: The edge label for this relationship.
+ related-link:
+ type: string
+ description: URL to the object in A&AI.
+ relationship-data:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/relationship-data"
+ related-to-property:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/related-to-property"
+ relationship-data:
+ required:
+ - relationship-key
+ - relationship-value
+ properties:
+ relationship-key:
+ type: string
+ description: A keyword provided by A&AI to indicate an attribute.
+ relationship-value:
+ type: string
+ description: Value of the attribute.
+ reserved-prop-names:
+ description: |
+ Internal map to define some reserved properties of a vertex
+ properties:
+ last-mod-source-of-truth:
+ type: string
+ aai-node-type:
+ type: string
+ aai-created-ts:
+ type: integer
+ format: int64
+ aai-unique-key:
+ type: string
+ aai-last-mod-ts:
+ type: integer
+ format: int64
+ source-of-truth:
+ type: string
+ aai-uri:
+ type: string
+ response-list:
+ description: |
+ Response container for the results of a named-query or model query
+ properties:
+ inventory-response-items:
+ type: object
+ $ref: "#/patchDefinitions/inventory-response-items"
+ result-data:
+ properties:
+ resource-type:
+ type: string
+ description: The specific type of node in the A&AI graph
+ resource-link:
+ type: string
+ description: The URL to the specific resource
+ route-table-reference:
+ description: |
+ Openstack route table reference.
+ ###### Related Nodes
+ - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
+ required:
+ - route-table-reference-id
+ - route-table-reference-fqdn
+ properties:
+ route-table-reference-id:
+ type: string
+ description: Route Table Reference id, UUID assigned to this instance.
+ route-table-reference-fqdn:
+ type: string
+ description: FQDN entry in the route table.
+ route-table-references:
+ description: |
+ Collection of openstack route table references
+ properties:
+ route-table-reference:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/route-table-reference"
+ route-target:
+ description: |
+ Route target information
+ ###### Related Nodes
+ - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
+ required:
+ - global-route-target
+ - route-target-role
+ properties:
+ global-route-target:
+ type: string
+ description: Number used to identify an RT, globally unique in the network
+ route-target-role:
+ type: string
+ description: Role assigned to this route target
+ route-targets:
+ description: |
+ Collection of route target information
+ properties:
+ route-target:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/route-target"
+ routing-instance:
+ description: |
+ ###### Related Nodes
+ - TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
+ - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
+ - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR
+ required:
+ - routing-instance-id
+ properties:
+ routing-instance-id:
+ type: string
+ description: Unique id of routing instance
+ rpm-owner:
+ type: string
+ description: rpm owner
+ routing-instances:
+ description: |
+ set of probes related to generic-vnf routing instance
+ properties:
+ routing-instance:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/routing-instance"
+ sdn-zone-response:
+ properties:
+ oam-networks:
+ type: object
+ $ref: "#/patchDefinitions/oam-networks"
+ az-and-dvs-switches:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/az-and-dvs-switches"
+ search:
+ properties:
+ edge-tag-query-result:
+ type: object
+ $ref: "#/patchDefinitions/edge-tag-query-result"
+ edge-tag-query-request:
+ type: object
+ $ref: "#/patchDefinitions/edge-tag-query-request"
+ search-results:
+ type: object
+ $ref: "#/patchDefinitions/search-results"
+ sdn-zone-response:
+ type: object
+ $ref: "#/patchDefinitions/sdn-zone-response"
+ search-results:
+ properties:
+ result-data:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/result-data"
+ secondary-filt:
+ description: |
+ SecondaryFilt for performing a named-query or model query
+ secondary-filter:
+ properties:
+ property-name:
+ type: string
+ filter-type:
+ type: string
+ property-value:
+ type: string
+ secondary-filts:
+ description: |
+ SecondaryFilts for performing a named-query or model query
+ properties:
+ secondary-filt:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/secondary-filt"
+ segmentation-assignment:
+ description: |
+ Openstack segmentation assignment.
+ ###### Related Nodes
+ - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
+ required:
+ - segmentation-id
+ properties:
+ segmentation-id:
+ type: string
+ description: Route Table Reference id, UUID assigned to this instance.
+ segmentation-assignments:
+ description: |
+ Collection of openstack segmentation assignments
+ properties:
+ segmentation-assignment:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/segmentation-assignment"
+ service:
+ description: |
+ Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services.
+ required:
+ - service-id
+ - service-description
+ properties:
+ service-id:
+ type: string
+ description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
+ service-description:
+ type: string
+ description: Description of the service
+ service-selflink:
+ type: string
+ description: URL to endpoint where AAI can get more details
+ service-capabilities:
+ description: |
+ Collection of service capabilities.
+ properties:
+ service-capability:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/service-capability"
+ service-capability:
+ description: |
+ Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this.
+ ###### Related Nodes
+ - FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
+ - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
+ - SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK
+ required:
+ - service-type
+ - vnf-type
+ properties:
+ service-type:
+ type: string
+ description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
+ vnf-type:
+ type: string
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ service-design-and-creation:
+ description: |
+ Namespace for objects managed by ASDC
+ properties:
+ vnf-images:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/vnf-image"
+ services:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/service"
+ service-capabilities:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/service-capability"
+ models:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/model"
+ named-queries:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/named-query"
+ service-instance:
+ description: |
+ Instance of a service
+ ###### Related Nodes
+ - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
+ - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
+ - TO owning-entity( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
+ - TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
+ - TO configuration( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
+ - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
+ - TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
+ - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY)
+ - TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
+ - TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
+ - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
+ - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
+ - TO zone( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
+ - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
+ - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
+ - TO model-ver( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One)
+ - FROM project( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
+ - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
+ - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
+ - FROM forwarding-path( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
+ - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM,FORWARDING-PATH
+ - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
+ required:
+ - service-instance-id
+ - service-type
+ - service-role
+ - created-at
+ - updated-at
+ - description
+ properties:
+ service-instance-id:
+ type: string
+ description: Uniquely identifies this instance of a service
+ service-instance-name:
+ type: string
+ description: This field will store a name assigned to the service-instance.
+ service-type:
+ type: string
+ description: String capturing type of service.
+ service-role:
+ type: string
+ description: String capturing the service role.
+ environment-context:
+ type: string
+ description: This field will store the environment context assigned to the service-instance.
+ workload-context:
+ type: string
+ description: This field will store the workload context assigned to the service-instance.
+ created-at:
+ type: string
+ description: create time of Network Service.
+ updated-at:
+ type: string
+ description: last update of Network Service.
+ description:
+ type: string
+ description: short description for service-instance.
+ model-invariant-id:
+ type: string
+ description: the ASDC model id for this resource or service model.
+ model-version-id:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ persona-model-version:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ widget-model-id:
+ type: string
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ widget-model-version:
+ type: string
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ bandwidth-total:
+ type: string
+ description: Indicates the total bandwidth to be used for this service.
+ bandwidth-up-wan1:
+ type: string
+ description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
+ bandwidth-down-wan1:
+ type: string
+ description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
+ bandwidth-up-wan2:
+ type: string
+ description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
+ bandwidth-down-wan2:
+ type: string
+ description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
+ vhn-portal-url:
+ type: string
+ description: URL customers will use to access the vHN Portal.
+ service-instance-location-id:
+ type: string
+ description: An identifier that customers assign to the location where this service is being used.
+ service-instances:
+ description: |
+ Collection of service instances
+ properties:
+ service-instance:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/service-instance"
+ service-subscription:
+ description: |
+ Object that group service instances.
+ ###### Related Nodes
+ - TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
+ - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
+ - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE
+ required:
+ - service-type
+ properties:
+ service-type:
+ type: string
+ description: Value defined by orchestration to identify this service across ECOMP.
+ temp-ub-sub-account-id:
+ type: string
+ description: This property will be deleted from A&AI in the near future. Only stop gap solution.
+ service-subscriptions:
+ description: |
+ Collection of objects that group service instances.
+ properties:
+ service-subscription:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/service-subscription"
+ services:
+ description: |
+ Collection of service model definitions. Likely to be deprecated in favor of models from ASDC.
+ properties:
+ service:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/service"
+ site-pair:
+ description: |
+ ###### Related Nodes
+ - TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
+ - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
+ - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE
+ required:
+ - site-pair-id
+ properties:
+ site-pair-id:
+ type: string
+ description: unique identifier of probe
+ source-ip:
+ type: string
+ description: Prefix address
+ destination-ip:
+ type: string
+ description: Prefix address
+ ip-version:
+ type: string
+ description: ip version, v4, v6
+ destination-hostname:
+ type: string
+ description: Hostname of the destination equipment to which SLAs are measured against.
+ destination-equip-type:
+ type: string
+ description: The type of destinatination equipment. Could be Router, UCPE, etc.
+ site-pair-set:
+ description: |
+ Set of instances for probes used to measure service level agreements
+ ###### Related Nodes
+ - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
+ - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
+ - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE
+ required:
+ - site-pair-set-id
+ properties:
+ site-pair-set-id:
+ type: string
+ description: Unique id of site pair set.
+ site-pair-sets:
+ description: |
+ Collection of sets of instances for probes related to generic-vnf
+ properties:
+ site-pair-set:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/site-pair-set"
+ site-pairs:
+ description: |
+ probe within a set
+ properties:
+ site-pair:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/site-pair"
+ snapshot:
+ description: |
+ Openstack snapshot
+ ###### Related Nodes
+ - TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
+ required:
+ - snapshot-id
+ properties:
+ snapshot-id:
+ type: string
+ description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
+ snapshot-name:
+ type: string
+ description: Snapshot name
+ snapshot-architecture:
+ type: string
+ description: Operating system architecture
+ snapshot-os-distro:
+ type: string
+ description: The common name of the operating system distribution in lowercase
+ snapshot-os-version:
+ type: string
+ description: The operating system version as specified by the distributor.
+ application:
+ type: string
+ description: The application that the image instantiates.
+ application-vendor:
+ type: string
+ description: The vendor of the application.
+ application-version:
+ type: string
+ description: The version of the application.
+ snapshot-selflink:
+ type: string
+ description: URL to endpoint where AAI can get more details
+ prev-snapshot-id:
+ type: string
+ description: This field contains the UUID of the previous snapshot (if any).
+ snapshots:
+ description: |
+ Collection of openstack snapshots
+ properties:
+ snapshot:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/snapshot"
+ sriov-pf:
+ description: |
+ SR-IOV Physical Function
+ ###### Related Nodes
+ - TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
+ - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
+ required:
+ - pf-pci-id
+ properties:
+ pf-pci-id:
+ type: string
+ description: Identifier for the sriov-pf
+ sriov-pfs:
+ description: |
+ Collection of SR-IOV Physical Functions.
+ properties:
+ sriov-pf:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/sriov-pf"
+ sriov-vf:
+ description: |
+ SR-IOV Virtual Function (not to be confused with virtual network function)
+ ###### Related Nodes
+ - TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
+ - TO sriov-pf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
+ required:
+ - pci-id
+ properties:
+ pci-id:
+ type: string
+ description: PCI ID used to identify the sriov-vf
+ vf-vlan-filter:
+ type: string
+ description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
+ vf-mac-filter:
+ type: string
+ description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
+ vf-vlan-strip:
+ type: boolean
+ description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
+ vf-vlan-anti-spoof-check:
+ type: boolean
+ description: This option ensures anti VLAN spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.
+ vf-mac-anti-spoof-check:
+ type: boolean
+ description: This option ensures anti MAC spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.
+ vf-mirrors:
+ type: string
+ description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
+ vf-broadcast-allow:
+ type: boolean
+ description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
+ vf-unknown-multicast-allow:
+ type: boolean
+ description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
+ vf-unknown-unicast-allow:
+ type: boolean
+ description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
+ vf-insert-stag:
+ type: boolean
+ description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
+ vf-link-status:
+ type: string
+ description: This option is used to set the link status. Valid values as of 1607 are on, off, and auto.
+ sriov-vfs:
+ description: |
+ Collection of SR-IOV Virtual Functions.
+ properties:
+ sriov-vf:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/sriov-vf"
+ start-node-filter:
+ properties:
+ property-name:
+ type: string
+ property-value:
+ type: string
+ subnet:
+ description: |
+ ###### Related Nodes
+ - TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
+ - FROM host-route( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
+ - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
+ - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
+ - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST
+ - SUBNET is DELETED when these are DELETED HOST-ROUTE
+ required:
+ - subnet-id
+ - dhcp-enabled
+ properties:
+ subnet-id:
+ type: string
+ description: Subnet ID, should be UUID.
+ subnet-name:
+ type: string
+ description: Name associated with the subnet.
+ neutron-subnet-id:
+ type: string
+ description: Neutron id of this subnet
+ gateway-address:
+ type: string
+ description: gateway ip address
+ network-start-address:
+ type: string
+ description: network start address
+ cidr-mask:
+ type: string
+ description: cidr mask
+ ip-version:
+ type: string
+ description: ip version
+ orchestration-status:
+ type: string
+ description: Orchestration status of this VNF, mastered by MSO
+ dhcp-enabled:
+ type: boolean
+ dhcp-start:
+ type: string
+ description: the start address reserved for use by dhcp
+ dhcp-end:
+ type: string
+ description: the last address reserved for use by dhcp
+ subnet-role:
+ type: string
+ description: role of the subnet, referenced when assigning IPs
+ ip-assignment-direction:
+ type: string
+ description: ip address assignment direction of the subnet
+ subnets:
+ properties:
+ subnet:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/subnet"
+ tagged-inventory-item-list:
+ properties:
+ inventory-item:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/inventory-item"
+ tenant:
+ description: |
+ Openstack tenant
+ ###### Related Nodes
+ - TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
+ - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
+ - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
+ - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
+ - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
+ - TENANT cannot be deleted if linked to VSERVER
+ required:
+ - tenant-id
+ - tenant-name
+ properties:
+ tenant-id:
+ type: string
+ description: Unique id relative to the cloud-region.
+ tenant-name:
+ type: string
+ description: Readable name of tenant
+ tenant-context:
+ type: string
+ description: This field will store the tenant context.
+ tenants:
+ description: |
+ Collection of openstack tenants.
+ properties:
+ tenant:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/tenant"
+ tunnel-xconnect:
+ description: |
+ Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
+ ###### Related Nodes
+ - TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
+ required:
+ - id
+ properties:
+ id:
+ type: string
+ description: Allotted Resource id UUID assigned to this instance.
+ bandwidth-up-wan1:
+ type: string
+ description: The WAN uplink bandwidth for WAN1
+ bandwidth-down-wan1:
+ type: string
+ description: The WAN downlink bandwidth for WAN1
+ bandwidth-up-wan2:
+ type: string
+ description: The WAN uplink bandwidth for WAN2
+ bandwidth-down-wan2:
+ type: string
+ description: The WAN downlink bandwidth for WAN2
+ tunnel-xconnects:
+ description: |
+ This object is used to store the specific tunnel cross connect aspects of an allotted resource
+ properties:
+ tunnel-xconnect:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/tunnel-xconnect"
+ update:
+ description: |
+ Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team.
+ required:
+ - update-node-type
+ properties:
+ update-node-type:
+ type: string
+ update-node-key:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/update-node-key"
+ update-node-uri:
+ type: string
+ action:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/action"
+ update-node-key:
+ properties:
+ key-name:
+ type: string
+ key-value:
+ type: string
+ vce:
+ description: |
+ Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated.
+ ###### Related Nodes
+ - TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
+ - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
+ - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY)
+ - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
+ - FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
+ - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
+ - VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP
+ required:
+ - vnf-id
+ - vnf-name
+ - vnf-type
+ properties:
+ vnf-id:
+ type: string
+ description: Unique id of VNF. This is unique across the graph.
+ vnf-name:
+ type: string
+ description: Name of VNF.
+ vnf-name2:
+ type: string
+ description: Alternate name of VNF.
+ vnf-type:
+ type: string
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ service-id:
+ type: string
+ description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
+ regional-resource-zone:
+ type: string
+ description: Regional way of organizing pservers, source of truth should define values
+ prov-status:
+ type: string
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ operational-status:
+ type: string
+ description: Indicator for whether the resource is considered operational
+ license-key:
+ type: string
+ description: OBSOLETE - do not use
+ equipment-role:
+ type: string
+ description: Network role being played by this VNF
+ orchestration-status:
+ type: string
+ description: Orchestration status of this VNF, mastered by MSO
+ heat-stack-id:
+ type: string
+ description: Heat stack id corresponding to this instance, managed by MSO
+ mso-catalog-key:
+ type: string
+ description: Corresponds to the SDN-C catalog id used to configure this VCE
+ vpe-id:
+ type: string
+ description: Unique ID of VPE connected to this VCE.
+ v6-vce-wan-address:
+ type: string
+ description: Valid v6 IP address for the WAN Link on this router. Implied length of /64.
+ ipv4-oam-address:
+ type: string
+ description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
+ vces:
+ description: |
+ Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated.
+ properties:
+ vce:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/vce"
+ vf-module:
+ description: |
+ a deployment unit of VNFCs
+ ###### Related Nodes
+ - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
+ - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
+ - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
+ - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
+ - TO model-ver( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One)
+ - VF-MODULE cannot be deleted if linked to VNFC
+ required:
+ - vf-module-id
+ - is-base-vf-module
+ properties:
+ vf-module-id:
+ type: string
+ description: Unique ID of vf-module.
+ vf-module-name:
+ type: string
+ description: Name of vf-module
+ heat-stack-id:
+ type: string
+ description: Heat stack id corresponding to this instance.
+ orchestration-status:
+ type: string
+ description: orchestration status of this vf-module, mastered by MSO
+ is-base-vf-module:
+ type: boolean
+ vf-modules:
+ description: |
+ Collection of vf-modules, a deployment unit of VNFCs
+ properties:
+ vf-module:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/vf-module"
+ vig-server:
+ description: |
+ vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
+ ###### Related Nodes
+ - TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
+ required:
+ - vig-address-type
+ properties:
+ vig-address-type:
+ type: string
+ description: indicates whether the VIG is for AVPN or INTERNET
+ ipaddress-v4-vig:
+ type: string
+ description: v4 IP of the vig server
+ ipaddress-v6-vig:
+ type: string
+ description: v6 IP of the vig server
+ vig-servers:
+ properties:
+ vig-server:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/vig-server"
+ vip-ipv4-address-list:
+ description: |
+ IPv4 Address Range
+ ###### Related Nodes
+ - TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
+ - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
+ required:
+ - vip-ipv4-address
+ properties:
+ vip-ipv4-address:
+ type: string
+ description: IP address
+ vip-ipv4-prefix-length:
+ type: integer
+ format: int64
+ description: Prefix length, 32 for single address
+ vlan-id-inner:
+ type: integer
+ format: int64
+ description: Inner VLAN tag
+ vlan-id-outer:
+ type: integer
+ format: int64
+ description: Outer VLAN tag
+ is-floating:
+ type: boolean
+ description: Indicator of fixed or floating address
+ vip-ipv6-address-list:
+ description: |
+ IPv6 Address Range
+ ###### Related Nodes
+ - TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
+ - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
+ required:
+ - vip-ipv6-address
+ properties:
+ vip-ipv6-address:
+ type: string
+ description: IP address
+ vip-ipv6-prefix-length:
+ type: integer
+ format: int64
+ description: Prefix length, 128 for single address
+ vlan-id-inner:
+ type: integer
+ format: int64
+ description: Inner VLAN tag
+ vlan-id-outer:
+ type: integer
+ format: int64
+ description: Outer VLAN tag
+ is-floating:
+ type: boolean
+ description: Indicator of fixed or floating address
+ virtual-data-center:
+ description: |
+ Virtual organization of cloud infrastructure elements in a data center context
+ ###### Related Nodes
+ - FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
+ required:
+ - vdc-id
+ - vdc-name
+ properties:
+ vdc-id:
+ type: string
+ description: Unique ID of the vdc
+ vdc-name:
+ type: string
+ description: Name of the virtual data center
+ virtual-data-centers:
+ description: |
+ Virtual organization of cloud infrastructure elements in a data center context
+ properties:
+ virtual-data-center:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/virtual-data-center"
+ vlan:
+ description: |
+ Definition of vlan
+ ###### Related Nodes
+ - TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
+ - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
+ - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
+ - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
+ - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
+ - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK
+ required:
+ - vlan-interface
+ - in-maint
+ - is-ip-unnumbered
+ properties:
+ vlan-interface:
+ type: string
+ description: String that identifies the interface
+ vlan-id-inner:
+ type: integer
+ format: int64
+ description: Inner VLAN tag
+ vlan-id-outer:
+ type: integer
+ format: int64
+ description: Outer VLAN tag
+ vlans:
+ properties:
+ vlan:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/vlan"
+ vnf:
+ description: |
+ Abstract vnf class
+ required:
+ - vnf-id
+ properties:
+ vnf-id:
+ type: string
+ description: Unique id of VNF. This is unique across the graph.
+ vnf-image:
+ description: |
+ Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge.
+ ###### Related Nodes
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
+ - VNF-IMAGE cannot be deleted if linked to GENERIC-VNF
+ required:
+ - vnf-image-uuid
+ - application
+ - application-vendor
+ properties:
+ vnf-image-uuid:
+ type: string
+ description: Unique ID of this asset
+ application:
+ type: string
+ description: The application that the image instantiates.
+ application-vendor:
+ type: string
+ description: The vendor of the application.
+ application-version:
+ type: string
+ description: The version of the application.
+ selflink:
+ type: string
+ description: URL to endpoint where AAI can get more details
+ vnf-images:
+ description: |
+ Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge.
+ properties:
+ vnf-image:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/vnf-image"
+ vnfc:
+ description: |
+ ###### Related Nodes
+ - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - TO instance-group( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO vip-ipv4-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
+ - TO vip-ipv6-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
+ - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
+ - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
+ - VNFC is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
+ required:
+ - vnfc-name
+ - nfc-naming-code
+ - nfc-function
+ - in-maint
+ - is-closed-loop-disabled
+ properties:
+ vnfc-name:
+ type: string
+ description: Unique ID of vnfc.
+ nfc-naming-code:
+ type: string
+ description: Short code that is used in naming instances of the item being modeled
+ nfc-function:
+ type: string
+ description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
+ prov-status:
+ type: string
+ description: prov status of this vnfc
+ orchestration-status:
+ type: string
+ description: Orchestration status of this VNF, mastered by APP-C
+ ipaddress-v4-oam-vip:
+ type: string
+ description: Oam V4 vip address of this vnfc
+ in-maint:
+ type: boolean
+ is-closed-loop-disabled:
+ type: boolean
+ group-notation:
+ type: string
+ description: Group notation of VNFC
+ model-invariant-id:
+ type: string
+ description: the ASDC model id for this resource or service model.
+ model-version-id:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ vnfcs:
+ description: |
+ virtual network components associated with a vserver from application controller.
+ properties:
+ vnfc:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/vnfc"
+ volume:
+ description: |
+ Ephemeral Block storage volume.
+ ###### Related Nodes
+ - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume)
+ required:
+ - volume-id
+ - volume-selflink
+ properties:
+ volume-id:
+ type: string
+ description: Unique ID of block storage volume relative to the vserver.
+ volume-selflink:
+ type: string
+ description: URL to endpoint where AAI can get more details
+ volume-group:
+ description: |
+ Persistent block-level storage.
+ ###### Related Nodes
+ - TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
+ - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
+ - FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
+ required:
+ - volume-group-id
+ - volume-group-name
+ - vnf-type
+ properties:
+ volume-group-id:
+ type: string
+ description: Unique ID of volume-group.
+ volume-group-name:
+ type: string
+ description: Name of the volume group.
+ heat-stack-id:
+ type: string
+ description: Heat stack id corresponding to this volume-group
+ vnf-type:
+ type: string
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ orchestration-status:
+ type: string
+ description: Orchestration status of this volume-group
+ model-customization-id:
+ type: string
+ description: captures the id of all the configuration used to customize the resource for the service.
+ vf-module-model-customization-id:
+ type: string
+ description: helps relate the volume group to the vf-module whose components will require the volume group
+ volume-groups:
+ description: |
+ Collection of persistent block-level storage.
+ properties:
+ volume-group:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/volume-group"
+ volumes:
+ description: |
+ Collection of ephemeral Block storage volumes.
+ properties:
+ volume:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/volume"
+ vpls-pe:
+ description: |
+ VPLS Provider Edge routers.
+ ###### Related Nodes
+ - TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
+ - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
+ - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
+ - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
+ required:
+ - equipment-name
+ properties:
+ equipment-name:
+ type: string
+ prov-status:
+ type: string
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ ipv4-oam-address:
+ type: string
+ description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
+ equipment-role:
+ type: string
+ description: Client should send valid enumerated value, e.g., VPLS-PE.
+ vlan-id-outer:
+ type: integer
+ format: int64
+ description: Temporary location for stag to get to VCE
+ vpls-pes:
+ description: |
+ Collection of VPLS Provider Edge routers
+ properties:
+ vpls-pe:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/vpls-pe"
+ vpn-binding:
+ description: |
+ VPN binding
+ ###### Related Nodes
+ - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY)
+ - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
+ - FROM route-target( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
+ - VPN-BINDING cannot be deleted if linked to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK
+ - VPN-BINDING is DELETED when these are DELETED ROUTE-TARGET
+ required:
+ - vpn-id
+ - vpn-name
+ properties:
+ vpn-id:
+ type: string
+ description: VPN ID, globally unique within A&AI
+ vpn-name:
+ type: string
+ description: VPN Name
+ vpn-platform:
+ type: string
+ description: the platform associated with the VPN example AVPN, Mobility
+ vpn-type:
+ type: string
+ description: Type of the vpn, should be taken from enumerated/valid values
+ vpn-region:
+ type: string
+ description: region of customer vpn
+ customer-vpn-id:
+ type: string
+ description: id for this customer vpn
+ route-distinguisher:
+ type: string
+ description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
+ vpn-bindings:
+ properties:
+ vpn-binding:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/vpn-binding"
+ vserver:
+ description: |
+ Virtual Servers, aka virtual machine or VM.
+ ###### Related Nodes
+ - TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
+ - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
+ - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
+ - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
+ - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
+ - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY)
+ - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
+ - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY)
+ - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
+ - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
+ - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
+ - VSERVER is DELETED when these are DELETED L-INTERFACE
+ - VSERVER deletion means associated objects of these types are also DELETED:VOLUME
+ required:
+ - vserver-id
+ - vserver-name
+ - vserver-selflink
+ - in-maint
+ - is-closed-loop-disabled
+ properties:
+ vserver-id:
+ type: string
+ description: Unique identifier for this vserver relative to its tenant
+ vserver-name:
+ type: string
+ description: Name of vserver
+ vserver-name2:
+ type: string
+ description: Alternative name of vserver
+ prov-status:
+ type: string
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ vserver-selflink:
+ type: string
+ description: URL to endpoint where AAI can get more details
+ in-maint:
+ type: boolean
+ is-closed-loop-disabled:
+ type: boolean
+ vservers:
+ description: |
+ Collection of virtual Servers, aka virtual machines or VMs.
+ properties:
+ vserver:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/vserver"
+ zone:
+ description: |
+ A zone is a grouping of assets in a location homing to the same connections into the CBB
+ ###### Related Nodes
+ - TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
+ - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
+ - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
+ required:
+ - zone-id
+ - zone-name
+ - design-type
+ - zone-context
+ properties:
+ zone-id:
+ type: string
+ description: Code assigned by AIC to the zone
+ zone-name:
+ type: string
+ description: English name associated with the zone
+ design-type:
+ type: string
+ description: Design of zone [Medium/Largeā€¦]
+ zone-context:
+ type: string
+ description: Context of zone [production/test]
+ status:
+ type: string
+ description: Status of a zone.
+ zones:
+ description: |
+ Collection of zones
+ properties:
+ zone:
+ type: array
+ items:
+ $ref: "#/patchDefinitions/zone"
+getDefinitions:
+ aai-internal:
+ properties:
+ property-name:
+ type: string
+ property-value:
+ type: string
+ action:
+ properties:
+ action-type:
+ type: string
+ action-data:
+ type: array
+ items:
+ $ref: "#/getDefinitions/action-data"
+ action-data:
+ properties:
+ property-name:
+ type: string
+ property-value:
+ type: string
+ actions:
+ description: |
+ APIs that are more action related than REST (e.g., notify, update).
+ properties:
+ update:
+ type: object
+ $ref: "#/getDefinitions/update"
+ notify:
+ type: object
+ $ref: "#/getDefinitions/notify"
+ allotted-resource:
+ description: |
+ Represents a slice or partial piece of a resource that gets separately allotted
+ ###### Related Nodes
+ - TO allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE)
+ - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
+ - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
+ - TO l-interface( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY)
+ - TO network-policy( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
+ - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
+ - TO vpn-binding( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY)
+ - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
+ - TO model-ver( allotted-resource org.onap.relationships.inventory.IsA model-ver, Many2One)
+ - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
+ - FROM configuration( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
+ - FROM allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE)
+ - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT
+ required:
+ - id
+ properties:
+ id:
+ type: string
+ description: Allotted Resource id UUID assigned to this instance.
+ description:
+ type: string
+ description: The descriptive information assigned to this allotted resource instance
+ selflink:
+ type: string
+ description: Link back to more information in the controller
+ model-invariant-id:
+ type: string
+ description: the ASDC model id for this resource or service model.
+ model-version-id:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ persona-model-version:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ resource-version:
+ type: string
+ description: Concurrency value
+ orchestration-status:
+ type: string
+ description: Orchestration status
+ operational-status:
+ type: string
+ description: Indicator for whether the resource is considered operational
+ type:
+ type: string
+ description: Generic description of the type of allotted resource.
+ role:
+ type: string
+ description: role in the network that this resource will be providing.
+ tunnel-xconnects:
+ type: array
+ items:
+ $ref: "#/getDefinitions/tunnel-xconnect"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ allotted-resources:
+ description: |
+ This object is used to store slices of services being offered
+ properties:
+ allotted-resource:
+ type: array
+ items:
+ $ref: "#/getDefinitions/allotted-resource"
+ availability-zone:
+ description: |
+ Availability zone, a collection of compute hosts/pservers
+ ###### Related Nodes
+ - TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
+ - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
+ - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
+ - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
+ - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
+ - AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
+ required:
+ - availability-zone-name
+ - hypervisor-type
+ properties:
+ availability-zone-name:
+ type: string
+ description: Name of the availability zone. Unique across a cloud region
+ hypervisor-type:
+ type: string
+ description: Type of hypervisor. Source of truth should define valid values.
+ operational-status:
+ type: string
+ description: State that indicates whether the availability zone should be used, etc. Source of truth should define valid values.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ availability-zones:
+ description: |
+ Collection of availability zones
+ properties:
+ availability-zone:
+ type: array
+ items:
+ $ref: "#/getDefinitions/availability-zone"
+ az-and-dvs-switches:
+ properties:
+ dvs-switches:
+ type: object
+ $ref: "#/getDefinitions/dvs-switches"
+ availability-zone:
+ type: object
+ $ref: "#/getDefinitions/availability-zone"
+ business:
+ description: |
+ Namespace for business related constructs
+ properties:
+ connectors:
+ type: array
+ items:
+ $ref: "#/getDefinitions/connector"
+ customers:
+ type: array
+ items:
+ $ref: "#/getDefinitions/customer"
+ lines-of-business:
+ type: array
+ items:
+ $ref: "#/getDefinitions/line-of-business"
+ owning-entities:
+ type: array
+ items:
+ $ref: "#/getDefinitions/owning-entity"
+ platforms:
+ type: array
+ items:
+ $ref: "#/getDefinitions/platform"
+ projects:
+ type: array
+ items:
+ $ref: "#/getDefinitions/project"
+ class-of-service:
+ description: |
+ ###### Related Nodes
+ - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
+ required:
+ - cos
+ properties:
+ cos:
+ type: string
+ description: unique identifier of probe
+ probe-id:
+ type: string
+ description: identifier of probe
+ probe-type:
+ type: string
+ description: type of probe
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ classes-of-service:
+ description: |
+ class-of-service of probe
+ properties:
+ class-of-service:
+ type: array
+ items:
+ $ref: "#/getDefinitions/class-of-service"
+ cloud-infrastructure:
+ description: |
+ Namespace for cloud infrastructure.
+ properties:
+ complexes:
+ type: array
+ items:
+ $ref: "#/getDefinitions/complex"
+ cloud-regions:
+ type: array
+ items:
+ $ref: "#/getDefinitions/cloud-region"
+ network-profiles:
+ type: array
+ items:
+ $ref: "#/getDefinitions/network-profile"
+ pservers:
+ type: array
+ items:
+ $ref: "#/getDefinitions/pserver"
+ virtual-data-centers:
+ type: array
+ items:
+ $ref: "#/getDefinitions/virtual-data-center"
+ operational-environments:
+ type: array
+ items:
+ $ref: "#/getDefinitions/operational-environment"
+ cloud-region:
+ description: |
+ cloud-region designates an installation of a cloud cluster or region or instantiation.
+ ###### Related Nodes
+ - TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many)
+ - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
+ - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
+ - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
+ - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
+ - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
+ - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE
+ - CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
+ required:
+ - cloud-owner
+ - cloud-region-id
+ - sriov-automation
+ properties:
+ cloud-owner:
+ type: string
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ cloud-region-id:
+ type: string
+ description: Identifier used by the vendor for the region. Second part of composite key
+ cloud-type:
+ type: string
+ description: Type of the cloud (e.g., openstack)
+ owner-defined-type:
+ type: string
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ cloud-region-version:
+ type: string
+ description: Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
+ identity-url:
+ type: string
+ description: URL of the keystone identity service
+ cloud-zone:
+ type: string
+ description: Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
+ complex-name:
+ type: string
+ description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
+ sriov-automation:
+ type: boolean
+ cloud-extra-info:
+ type: string
+ description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
+ cloud-epa-caps:
+ type: string
+ description: MultiVIM will discover and expose EPA capabilities.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ volume-groups:
+ type: array
+ items:
+ $ref: "#/getDefinitions/volume-group"
+ tenants:
+ type: array
+ items:
+ $ref: "#/getDefinitions/tenant"
+ flavors:
+ type: array
+ items:
+ $ref: "#/getDefinitions/flavor"
+ group-assignments:
+ type: array
+ items:
+ $ref: "#/getDefinitions/group-assignment"
+ snapshots:
+ type: array
+ items:
+ $ref: "#/getDefinitions/snapshot"
+ images:
+ type: array
+ items:
+ $ref: "#/getDefinitions/image"
+ dvs-switches:
+ type: array
+ items:
+ $ref: "#/getDefinitions/dvs-switch"
+ oam-networks:
+ type: array
+ items:
+ $ref: "#/getDefinitions/oam-network"
+ availability-zones:
+ type: array
+ items:
+ $ref: "#/getDefinitions/availability-zone"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ vip-ipv4-address-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/vip-ipv4-address-list"
+ vip-ipv6-address-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/vip-ipv6-address-list"
+ cloud-regions:
+ properties:
+ cloud-region:
+ type: array
+ items:
+ $ref: "#/getDefinitions/cloud-region"
+ complex:
+ description: |
+ Collection of physical locations that can house cloud-regions.
+ ###### Related Nodes
+ - TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
+ - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
+ - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
+ - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
+ - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
+ - COMPLEX is DELETED when these are DELETED CTAG-POOL
+ required:
+ - physical-location-id
+ - physical-location-type
+ - street1
+ - city
+ - postal-code
+ - country
+ - region
+ properties:
+ physical-location-id:
+ type: string
+ description: Unique identifier for physical location, e.g., CLLI
+ data-center-code:
+ type: string
+ description: Data center code which can be an alternate way to identify a complex
+ complex-name:
+ type: string
+ description: Gamma complex name for LCP instance.
+ identity-url:
+ type: string
+ description: URL of the keystone identity service
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ physical-location-type:
+ type: string
+ description: Type, e.g., central office, data center.
+ street1:
+ type: string
+ street2:
+ type: string
+ city:
+ type: string
+ state:
+ type: string
+ postal-code:
+ type: string
+ country:
+ type: string
+ region:
+ type: string
+ latitude:
+ type: string
+ longitude:
+ type: string
+ elevation:
+ type: string
+ lata:
+ type: string
+ ctag-pools:
+ type: array
+ items:
+ $ref: "#/getDefinitions/ctag-pool"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ complexes:
+ description: |
+ Collection of physical locations that can house cloud-regions.
+ properties:
+ complex:
+ type: array
+ items:
+ $ref: "#/getDefinitions/complex"
+ configuration:
+ description: |
+ Port Mirror Configuration.
+ ###### Related Nodes
+ - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
+ - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
+ - TO l-interface( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY)
+ - TO pnf( configuration org.onap.relationships.inventory.AppliesTo pnf, ONE2MANY)
+ - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
+ - FROM forwarder( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
+ - FROM forwarding-path( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
+ - FROM evc( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
+ - FROM forwarder-evc( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
+ - CONFIGURATION is DELETED when these are DELETED METADATUM,EVC,FORWARDER-EVC
+ - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK
+ required:
+ - configuration-id
+ - configuration-type
+ - configuration-sub-type
+ - orchestration-status
+ - operational-status
+ - configuration-selflink
+ - model-customization-id
+ properties:
+ configuration-id:
+ type: string
+ description: UUID assigned to configuration.
+ management-option:
+ type: string
+ description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
+ configuration-name:
+ type: string
+ description: Name of the configuration.
+ configuration-type:
+ type: string
+ description: port-mirroring-configuration.
+ configuration-sub-type:
+ type: string
+ description: vprobe, pprobe.
+ model-invariant-id:
+ type: string
+ description: the ASDC model id for this resource or service model.
+ model-version-id:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ orchestration-status:
+ type: string
+ description: Orchestration status of the configuration.
+ operational-status:
+ type: string
+ description: Indicator for whether the resource is considered operational.
+ configuration-selflink:
+ type: string
+ description: URL to endpoint where AAI can get more details from SDN-GC.
+ model-customization-id:
+ type: string
+ description: id of the configuration used to customize the resource
+ tunnel-bandwidth:
+ type: string
+ description: DHV Site Effective Bandwidth
+ vendor-allowed-max-bandwidth:
+ type: string
+ description: Velocloud Nominal Throughput - VNT
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ metadata:
+ type: array
+ items:
+ $ref: "#/getDefinitions/metadatum"
+ forwarder-evcs:
+ type: array
+ items:
+ $ref: "#/getDefinitions/forwarder-evc"
+ evcs:
+ type: array
+ items:
+ $ref: "#/getDefinitions/evc"
+ configurations:
+ description: |
+ Collection of configurations
+ properties:
+ configuration:
+ type: array
+ items:
+ $ref: "#/getDefinitions/configuration"
+ connector:
+ description: |
+ Collection of resource instances used to connect a variety of disparate inventory widgets
+ ###### Related Nodes
+ - TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
+ - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
+ - CONNECTOR is DELETED when these are DELETED METADATUM
+ required:
+ - resource-instance-id
+ properties:
+ resource-instance-id:
+ type: string
+ description: Unique id of resource instance.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ model-invariant-id:
+ type: string
+ description: the ASDC model id for this resource or service model.
+ model-version-id:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ persona-model-version:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ widget-model-id:
+ type: string
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ widget-model-version:
+ type: string
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ metadata:
+ type: array
+ items:
+ $ref: "#/getDefinitions/metadatum"
+ connectors:
+ description: |
+ Collection of resource instances used to connect a variety of disparate inventory widgets
+ properties:
+ connector:
+ type: array
+ items:
+ $ref: "#/getDefinitions/connector"
+ constrained-element-set:
+ description: |
+ This is how we would capture constraints defining allowed sets of elements.
+ ###### Related Nodes
+ - TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
+ - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
+ - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
+ - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET
+ required:
+ - constrained-element-set-uuid
+ - constraint-type
+ - check-type
+ properties:
+ constrained-element-set-uuid:
+ type: string
+ constraint-type:
+ type: string
+ check-type:
+ type: string
+ resource-version:
+ type: string
+ element-choice-sets:
+ type: array
+ items:
+ $ref: "#/getDefinitions/element-choice-set"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ constrained-element-sets:
+ properties:
+ constrained-element-set:
+ type: array
+ items:
+ $ref: "#/getDefinitions/constrained-element-set"
+ ctag-assignment:
+ description: |
+ ###### Related Nodes
+ - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
+ required:
+ - vlan-id-inner
+ properties:
+ vlan-id-inner:
+ type: integer
+ format: int64
+ description: id.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ ctag-assignments:
+ properties:
+ ctag-assignment:
+ type: array
+ items:
+ $ref: "#/getDefinitions/ctag-assignment"
+ ctag-pool:
+ description: |
+ A collection of C tags (vlan tags) grouped for a specific purpose.
+ ###### Related Nodes
+ - TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
+ - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
+ - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
+ required:
+ - target-pe
+ - availability-zone-name
+ - ctag-pool-purpose
+ properties:
+ target-pe:
+ type: string
+ description: The Target provider edge router
+ availability-zone-name:
+ type: string
+ description: Name of the availability zone
+ ctag-pool-purpose:
+ type: string
+ description: Describes what the intended purpose of this pool is.
+ ctag-values:
+ type: string
+ description: Comma separated list of ctags
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ ctag-pools:
+ properties:
+ ctag-pool:
+ type: array
+ items:
+ $ref: "#/getDefinitions/ctag-pool"
+ customer:
+ description: |
+ customer identifiers to provide linkage back to BSS information.
+ ###### Related Nodes
+ - FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
+ - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION
+ required:
+ - global-customer-id
+ - subscriber-name
+ - subscriber-type
+ properties:
+ global-customer-id:
+ type: string
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ subscriber-name:
+ type: string
+ description: Subscriber name, an alternate way to retrieve a customer.
+ subscriber-type:
+ type: string
+ description: Subscriber type, a way to provide VID with only the INFRA customers.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ service-subscriptions:
+ type: array
+ items:
+ $ref: "#/getDefinitions/service-subscription"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ customers:
+ description: |
+ Collection of customer identifiers to provide linkage back to BSS information.
+ properties:
+ customer:
+ type: array
+ items:
+ $ref: "#/getDefinitions/customer"
+ cvlan-tag-entry:
+ required:
+ - cvlan-tag
+ properties:
+ cvlan-tag:
+ type: integer
+ format: int64
+ description: See mis-na-virtualization-platform.yang
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ cvlan-tags:
+ properties:
+ cvlan-tag-entry:
+ type: array
+ items:
+ $ref: "#/getDefinitions/cvlan-tag-entry"
+ dvs-switch:
+ 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.
+ ###### Related Nodes
+ - TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
+ required:
+ - switch-name
+ - vcenter-url
+ properties:
+ switch-name:
+ type: string
+ description: DVS switch name
+ vcenter-url:
+ type: string
+ description: URL used to reach the vcenter
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ dvs-switches:
+ description: |
+ Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
+ properties:
+ dvs-switch:
+ type: array
+ items:
+ $ref: "#/getDefinitions/dvs-switch"
+ edge-prop-names:
+ description: |
+ Internal map to define the properties of an edge and interpret the map EdgeRules
+ properties:
+ edgeLabel:
+ type: string
+ direction:
+ type: string
+ multiplicityRule:
+ type: string
+ contains-other-v:
+ type: string
+ delete-other-v:
+ type: string
+ SVC-INFRA:
+ type: string
+ prevent-delete:
+ type: string
+ aai-uuid:
+ type: string
+ edge-tag-query-request:
+ properties:
+ edge-tag:
+ type: string
+ result-detail:
+ type: string
+ start-node-type:
+ type: string
+ start-node-filter:
+ type: array
+ items:
+ $ref: "#/getDefinitions/start-node-filter"
+ include-node-filter:
+ type: array
+ items:
+ $ref: "#/getDefinitions/include-node-filter"
+ secondary-filter:
+ type: array
+ items:
+ $ref: "#/getDefinitions/secondary-filter"
+ edge-tag-query-result:
+ properties:
+ tagged-inventory-item-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/tagged-inventory-item-list"
+ element-choice-set:
+ description: |
+ This is how we would capture constraints defining allowed sets of elements.
+ ###### Related Nodes
+ - TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
+ - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
+ - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT
+ required:
+ - element-choice-set-uuid
+ - element-choice-set-name
+ properties:
+ element-choice-set-uuid:
+ type: string
+ element-choice-set-name:
+ type: string
+ cardinality:
+ type: string
+ resource-version:
+ type: string
+ model-elements:
+ type: array
+ items:
+ $ref: "#/getDefinitions/model-element"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ element-choice-sets:
+ properties:
+ element-choice-set:
+ type: array
+ items:
+ $ref: "#/getDefinitions/element-choice-set"
+ entitlement:
+ description: |
+ Metadata for entitlement group.
+ ###### Related Nodes
+ - TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
+ required:
+ - group-uuid
+ - resource-uuid
+ properties:
+ group-uuid:
+ type: string
+ description: Unique ID for the entitlement group the resource comes from, should be uuid.
+ resource-uuid:
+ type: string
+ description: Unique ID of an entitlement resource.
+ resource-version:
+ type: string
+ description: Concurrency value
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ entitlements:
+ description: |
+ Entitlements, keyed by group-uuid and resource-uuid, related to license management
+ properties:
+ entitlement:
+ type: array
+ items:
+ $ref: "#/getDefinitions/entitlement"
+ esr-ems:
+ description: |
+ Persist EMS address information used by EMS driver.
+ ###### Related Nodes
+ - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)
+ - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
+ required:
+ - ems-id
+ properties:
+ ems-id:
+ type: string
+ description: Unique ID of EMS.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ esr-system-info-list:
+ type: object
+ $ref: "#/getDefinitions/esr-system-info-list"
+ relationship-list:
+ type: object
+ $ref: "#/getDefinitions/relationship-list"
+ esr-ems-list:
+ properties:
+ esr-ems:
+ type: array
+ items:
+ $ref: "#/getDefinitions/esr-ems"
+ esr-system-info:
+ description: |
+ Persist common address information of external systems.
+ ###### Related Nodes
+ - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)
+ - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)
+ - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)
+ - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)
+ required:
+ - esr-system-info-id
+ - user-name
+ - password
+ - system-type
+ properties:
+ esr-system-info-id:
+ type: string
+ description: Unique ID of esr system info.
+ system-name:
+ type: string
+ description: name of external system.
+ type:
+ type: string
+ description: type of external systems.
+ vendor:
+ type: string
+ description: vendor of external systems.
+ version:
+ type: string
+ description: version of external systems.
+ service-url:
+ type: string
+ description: url used to access external systems.
+ user-name:
+ type: string
+ description: username used to access external systems.
+ password:
+ type: string
+ description: password used to access external systems.
+ system-type:
+ type: string
+ description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
+ protocol:
+ type: string
+ description: protocol of third party SDNC, for example netconf/snmp.
+ ssl-cacert:
+ type: string
+ description: ca file content if enabled ssl on auth-url.
+ ssl-insecure:
+ type: boolean
+ description: Whether to verify VIM's certificate.
+ ip-address:
+ type: string
+ description: service IP of ftp server.
+ port:
+ type: string
+ description: service port of ftp server.
+ cloud-domain:
+ type: string
+ description: domain info for authentication.
+ default-tenant:
+ type: string
+ description: default tenant of VIM.
+ passive:
+ type: boolean
+ description: ftp passive mode or not.
+ remote-path:
+ type: string
+ description: resource or performance data file path.
+ system-status:
+ type: string
+ description: the status of external system.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: object
+ $ref: "#/getDefinitions/relationship-list"
+ esr-system-info-list:
+ description: |
+ Collection of persistent block-level external system auth info.
+ properties:
+ esr-system-info:
+ type: array
+ items:
+ $ref: "#/getDefinitions/esr-system-info"
+ esr-thirdparty-sdnc:
+ description: |
+ Persist SDNC address information used by ONAP SDNC.
+ ###### Related Nodes
+ - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)
+ - TO pnf( esr-thirdparty-sdnc has pnf, One2Many)
+ - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
+ required:
+ - thirdparty-sdnc-id
+ properties:
+ thirdparty-sdnc-id:
+ type: string
+ description: Unique ID of SDNC.
+ location:
+ type: string
+ description: used for DC type to indicate the location of SDNC, such as Core or Edge.
+ product-name:
+ type: string
+ description: password used to access SDNC server.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ esr-system-info-list:
+ type: object
+ $ref: "#/getDefinitions/esr-system-info-list"
+ relationship-list:
+ type: object
+ $ref: "#/getDefinitions/relationship-list"
+ esr-thirdparty-sdnc-list:
+ properties:
+ esr-thirdparty-sdnc:
+ type: array
+ items:
+ $ref: "#/getDefinitions/esr-thirdparty-sdnc"
+ esr-vnfm:
+ description: |
+ Persist VNFM address information used by VF-C.
+ ###### Related Nodes
+ - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)
+ - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
+ required:
+ - vnfm-id
+ properties:
+ vnfm-id:
+ type: string
+ description: Unique ID of VNFM.
+ vim-id:
+ type: string
+ description: indecate the VIM to deploy VNF.
+ certificate-url:
+ type: string
+ description: certificate url of VNFM.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ esr-system-info-list:
+ type: object
+ $ref: "#/getDefinitions/esr-system-info-list"
+ relationship-list:
+ type: object
+ $ref: "#/getDefinitions/relationship-list"
+ esr-vnfm-list:
+ properties:
+ esr-vnfm:
+ type: array
+ items:
+ $ref: "#/getDefinitions/esr-vnfm"
+ evc:
+ description: |
+ evc object is an optional child object of the Configuration object.
+ ###### Related Nodes
+ - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
+ required:
+ - evc-id
+ properties:
+ evc-id:
+ type: string
+ description: Unique/key field for the evc object
+ forwarding-path-topology:
+ type: string
+ description: Point-to-Point, Multi-Point
+ cir-value:
+ type: string
+ description: Commited Information Rate
+ cir-units:
+ type: string
+ description: CIR units
+ connection-diversity-group-id:
+ type: string
+ description: Diversity Group ID
+ service-hours:
+ type: string
+ description: formerly Performance Group
+ esp-evc-circuit-id:
+ type: string
+ description: EVC Circuit ID of ESP EVC
+ esp-evc-cir-value:
+ type: string
+ description: Committed Information Rate (For ESP)
+ esp-evc-cir-units:
+ type: string
+ description: CIR units (For ESP)
+ esp-itu-code:
+ type: string
+ description: Identifies ESP
+ collector-pop-clli:
+ type: string
+ description: Collector POP CLLI (from the hostname of the access pnf)
+ inter-connect-type-ingress:
+ type: string
+ description: Interconnect type on ingress side of EVC.
+ tagmode-access-ingress:
+ type: string
+ description: tagode for collector side of EVC
+ tagmode-access-egress:
+ type: string
+ description: tagMode for network side of EVC
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ evcs:
+ properties:
+ evc:
+ type: array
+ items:
+ $ref: "#/getDefinitions/evc"
+ external-system:
+ description: |
+ Namespace for external system.
+ properties:
+ esr-ems-list:
+ type: object
+ $ref: "#/getDefinitions/esr-ems-list"
+ esr-vnfm-list:
+ type: object
+ $ref: "#/getDefinitions/esr-vnfm-list"
+ esr-thirdparty-sdnc-list:
+ type: object
+ $ref: "#/getDefinitions/esr-thirdparty-sdnc-list"
+ extra-properties:
+ description: |
+ Extra properties for inventory item for response list
+ properties:
+ extra-property:
+ type: array
+ items:
+ $ref: "#/getDefinitions/extra-property"
+ extra-property:
+ properties:
+ property-name:
+ type: string
+ property-value:
+ type: string
+ flavor:
+ description: |
+ Openstack flavor.
+ ###### Related Nodes
+ - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
+ - FLAVOR cannot be deleted if linked to VSERVER
+ required:
+ - flavor-id
+ - flavor-name
+ - flavor-selflink
+ properties:
+ flavor-id:
+ type: string
+ description: Flavor id, expected to be unique across cloud-region.
+ flavor-name:
+ type: string
+ description: Flavor name
+ flavor-vcpus:
+ type: integer
+ format: int32
+ description: Number of CPUs
+ flavor-ram:
+ type: integer
+ format: int32
+ description: Amount of memory
+ flavor-disk:
+ type: integer
+ format: int32
+ description: Disk space
+ flavor-ephemeral:
+ type: integer
+ format: int32
+ description: Amount of ephemeral disk space
+ flavor-swap:
+ type: string
+ description: amount of swap space allocation
+ flavor-is-public:
+ type: boolean
+ description: whether flavor is available to all users or private to the tenant it was created in.
+ flavor-selflink:
+ type: string
+ description: URL to endpoint where AAI can get more details
+ flavor-disabled:
+ type: boolean
+ description: Boolean as to whether this flavor is no longer enabled
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ flavors:
+ description: |
+ Collection of openstack flavors.
+ properties:
+ flavor:
+ type: array
+ items:
+ $ref: "#/getDefinitions/flavor"
+ forwarder:
+ description: |
+ Entity describing a sequenced segment of forwarding path
+ ###### Related Nodes
+ - TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
+ - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
+ - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
+ - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
+ - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
+ - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION
+ required:
+ - sequence
+ properties:
+ sequence:
+ type: integer
+ format: int32
+ description: Unique ID of this segmentation
+ forwarder-role:
+ type: string
+ description: ingress, intermediate, egress
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ forwarder-evc:
+ description: |
+ forwarder object is an optional child object of the Configuration object.
+ ###### Related Nodes
+ - TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
+ required:
+ - forwarder-evc-id
+ properties:
+ forwarder-evc-id:
+ type: string
+ description: Key for forwarder-evc object
+ circuit-id:
+ type: string
+ description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
+ ivlan:
+ type: string
+ description: Internal VLAN.
+ svlan:
+ type: string
+ description: SVLAN value for ingress of egress forwarder.
+ cvlan:
+ type: string
+ description: CVLAN value for ingress of egress forwarder.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ forwarder-evcs:
+ properties:
+ forwarder-evc:
+ type: array
+ items:
+ $ref: "#/getDefinitions/forwarder-evc"
+ forwarders:
+ properties:
+ forwarder:
+ type: array
+ items:
+ $ref: "#/getDefinitions/forwarder"
+ forwarding-path:
+ description: |
+ Entity that describes the sequenced forwarding path between interfaces of services or resources
+ ###### Related Nodes
+ - TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
+ - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
+ - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
+ - FORWARDING-PATH is DELETED when these are DELETED FORWARDER
+ - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION
+ required:
+ - forwarding-path-id
+ - forwarding-path-name
+ properties:
+ forwarding-path-id:
+ type: string
+ description: Unique ID of this FP
+ forwarding-path-name:
+ type: string
+ description: Name of the FP
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ selflink:
+ type: string
+ description: the self link for this FP
+ forwarders:
+ type: array
+ items:
+ $ref: "#/getDefinitions/forwarder"
+ forwarding-paths:
+ properties:
+ forwarding-path:
+ type: array
+ items:
+ $ref: "#/getDefinitions/forwarding-path"
+ generic-vnf:
+ description: |
+ General purpose VNF
+ ###### Related Nodes
+ - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
+ - TO complex( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
+ - TO configuration( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
+ - TO ctag-pool( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
+ - TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
+ - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
+ - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY)
+ - TO pnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY)
+ - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
+ - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
+ - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
+ - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
+ - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
+ - TO model-ver( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One)
+ - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
+ - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
+ - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
+ - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - FROM line-of-business( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
+ - FROM platform( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
+ - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE
+ - GENERIC-VNF deletion means associated objects of these types are also DELETED:CONFIGURATION
+ required:
+ - vnf-id
+ - vnf-instance-id
+ - vnf-name
+ - vnf-type
+ - vnf-package-name
+ - vnf-discriptor-name
+ - job-id
+ - in-maint
+ - is-closed-loop-disabled
+ properties:
+ vnf-id:
+ type: string
+ description: Unique id of VNF. This is unique across the graph.
+ vnf-instance-id:
+ type: string
+ description: vnf instance id.
+ vnf-name:
+ type: string
+ description: Name of VNF.
+ vnf-name2:
+ type: string
+ description: Alternate name of VNF.
+ vnf-type:
+ type: string
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ service-id:
+ type: string
+ description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
+ regional-resource-zone:
+ type: string
+ description: Regional way of organizing pservers, source of truth should define values
+ prov-status:
+ type: string
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ operational-status:
+ type: string
+ description: Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.
+ license-key:
+ type: string
+ description: OBSOLETE - do not use
+ equipment-role:
+ type: string
+ description: Client should send valid enumerated value
+ orchestration-status:
+ type: string
+ description: Orchestration status of this VNF, used by MSO.
+ vnf-package-name:
+ type: string
+ vnf-discriptor-name:
+ type: string
+ description: vnf discriptor name
+ job-id:
+ type: string
+ description: job id corresponding to vnf
+ heat-stack-id:
+ type: string
+ description: Heat stack id corresponding to this instance, managed by MSO
+ mso-catalog-key:
+ type: string
+ description: Corresponds to the SDN-C catalog id used to configure this VCE
+ management-option:
+ type: string
+ description: identifier of managed by ATT or customer
+ ipv4-oam-address:
+ type: string
+ description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
+ ipv4-loopback0-address:
+ type: string
+ description: v4 Loopback0 address
+ nm-lan-v6-address:
+ type: string
+ description: v6 Loopback address
+ management-v6-address:
+ type: string
+ description: v6 management address
+ vcpu:
+ type: integer
+ format: int64
+ description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
+ vcpu-units:
+ type: string
+ description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE
+ vmemory:
+ type: integer
+ format: int64
+ description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
+ vmemory-units:
+ type: string
+ description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE
+ vdisk:
+ type: integer
+ format: int64
+ description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE
+ vdisk-units:
+ type: string
+ description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE
+ nshd:
+ type: integer
+ format: int64
+ description: number of associated SHD in vnf.
+ nvm:
+ type: integer
+ format: int64
+ description: number of vms in vnf.
+ nnet:
+ type: integer
+ format: int64
+ description: number of network in vnf.
+ in-maint:
+ type: boolean
+ is-closed-loop-disabled:
+ type: boolean
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ summary-status:
+ type: string
+ description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.
+ encrypted-access-flag:
+ type: boolean
+ description: indicates whether generic-vnf access uses SSH
+ entitlement-assignment-group-uuid:
+ type: string
+ description: UUID of the Entitlement group used for licensing VNFs, OBSOLETE - See child relationships.
+ entitlement-resource-uuid:
+ type: string
+ description: UUID of the specific entitlement resource. OBSOLETE - See child relationships.
+ license-assignment-group-uuid:
+ type: string
+ description: UUID of the license assignment group. OBSOLETE - See child relationships.
+ license-key-uuid:
+ type: string
+ description: UUID of the actual license resource. OBSOLETE - See child relationships.
+ model-invariant-id:
+ type: string
+ description: the ASDC model id for this resource or service model.
+ model-version-id:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ persona-model-version:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ model-customization-id:
+ type: string
+ description: captures the id of all the configuration used to customize the resource for the service.
+ widget-model-id:
+ type: string
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ widget-model-version:
+ type: string
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ as-number:
+ type: string
+ description: as-number of the VNF
+ regional-resource-subzone:
+ type: string
+ description: represents sub zone of the rr plane
+ nf-type:
+ type: string
+ description: Generic description of the type of NF
+ nf-function:
+ type: string
+ description: English description of Network function that the specific VNF deployment is providing
+ nf-role:
+ type: string
+ description: role in the network that this model will be providing
+ nf-naming-code:
+ type: string
+ description: string assigned to this model used for naming purposes
+ selflink:
+ type: string
+ description: Path to the controller object.
+ ipv4-oam-gateway-address:
+ type: string
+ description: Gateway address
+ ipv4-oam-gateway-address-prefix-length:
+ type: integer
+ format: int32
+ description: Prefix length for oam-address
+ vlan-id-outer:
+ type: integer
+ format: int64
+ description: Temporary location for S-TAG to get to VCE
+ nm-profile-name:
+ type: string
+ description: Network Management profile of this VNF
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ l-interfaces:
+ type: array
+ items:
+ $ref: "#/getDefinitions/l-interface"
+ lag-interfaces:
+ type: array
+ items:
+ $ref: "#/getDefinitions/lag-interface"
+ vf-modules:
+ type: array
+ items:
+ $ref: "#/getDefinitions/vf-module"
+ licenses:
+ type: array
+ items:
+ $ref: "#/getDefinitions/license"
+ entitlements:
+ type: array
+ items:
+ $ref: "#/getDefinitions/entitlement"
+ generic-vnfs:
+ description: |
+ Collection of VNFs
+ properties:
+ generic-vnf:
+ type: array
+ items:
+ $ref: "#/getDefinitions/generic-vnf"
+ group-assignment:
+ description: |
+ Openstack group-assignment used to store exclusivity groups (EG).
+ ###### Related Nodes
+ - TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
+ - FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
+ required:
+ - group-id
+ - group-type
+ - group-name
+ properties:
+ group-id:
+ type: string
+ description: Group id, expected to be unique across cloud-region.
+ group-type:
+ type: string
+ description: Group type - the type of group this instance refers to
+ group-name:
+ type: string
+ description: Group name - name assigned to the group
+ group-description:
+ type: string
+ description: Group description - description of the group
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ group-assignments:
+ description: |
+ Collection of openstack group assignments
+ properties:
+ group-assignment:
+ type: array
+ items:
+ $ref: "#/getDefinitions/group-assignment"
+ host-route:
+ description: |
+ ###### Related Nodes
+ - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
+ required:
+ - host-route-id
+ - route-prefix
+ - next-hop
+ properties:
+ host-route-id:
+ type: string
+ description: host-route id
+ route-prefix:
+ type: string
+ description: subnet prefix
+ next-hop:
+ type: string
+ description: Could be ip-address, hostname, or service-instance
+ next-hop-type:
+ type: string
+ description: Should be ip-address, hostname, or service-instance to match next-hop
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ host-routes:
+ properties:
+ host-route:
+ type: array
+ items:
+ $ref: "#/getDefinitions/host-route"
+ image:
+ description: |
+ Openstack image.
+ ###### Related Nodes
+ - TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
+ - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
+ - IMAGE cannot be deleted if linked to VSERVER
+ - IMAGE is DELETED when these are DELETED METADATUM
+ required:
+ - image-id
+ - image-name
+ - image-os-distro
+ - image-os-version
+ - image-selflink
+ properties:
+ image-id:
+ type: string
+ description: Image id, expected to be unique across cloud region
+ image-name:
+ type: string
+ description: Image name
+ image-architecture:
+ type: string
+ description: Operating system architecture.
+ image-os-distro:
+ type: string
+ description: The common name of the operating system distribution in lowercase
+ image-os-version:
+ type: string
+ description: The operating system version as specified by the distributor.
+ application:
+ type: string
+ description: The application that the image instantiates.
+ application-vendor:
+ type: string
+ description: The vendor of the application.
+ application-version:
+ type: string
+ description: The version of the application.
+ image-selflink:
+ type: string
+ description: URL to endpoint where AAI can get more details
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ metadata:
+ type: array
+ items:
+ $ref: "#/getDefinitions/metadatum"
+ images:
+ description: |
+ Collectio of Openstack images.
+ properties:
+ image:
+ type: array
+ items:
+ $ref: "#/getDefinitions/image"
+ include-node-filter:
+ properties:
+ include-node-type:
+ type: string
+ instance-filter:
+ description: |
+ InstanceFilter for performing a named-query or model query
+ instance-filters:
+ description: |
+ InstanceFilters for performing a named-query or model query
+ properties:
+ instance-filter:
+ type: array
+ items:
+ $ref: "#/getDefinitions/instance-filter"
+ instance-group:
+ description: |
+ General mechanism for grouping instances
+ ###### Related Nodes
+ - TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
+ - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
+ - FROM l3-network( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - FROM l-interface( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - FROM vnfc( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ required:
+ - instance-group-role
+ - model-invariant-id
+ - model-version-id
+ - id
+ - description
+ - type
+ properties:
+ instance-group-role:
+ type: string
+ description: role of the instance group.
+ model-invariant-id:
+ type: string
+ description: ASDC model id for this resource or service model.
+ model-version-id:
+ type: string
+ description: ASDC model version uid for this resource model.
+ id:
+ type: string
+ description: Instance Group ID, UUID assigned to this instance.
+ description:
+ type: string
+ description: Descriptive text to help identify the usage of this instance-group
+ type:
+ type: string
+ description: Only valid value today is lower case ha for high availability
+ sub-type:
+ type: string
+ description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
+ resource-version:
+ type: string
+ description: Concurrency value
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ instance-groups:
+ description: |
+ Collection of openstack route table references
+ properties:
+ instance-group:
+ type: array
+ items:
+ $ref: "#/getDefinitions/instance-group"
+ inventory:
+ properties:
+ search:
+ type: object
+ $ref: "#/getDefinitions/search"
+ actions:
+ type: object
+ $ref: "#/getDefinitions/actions"
+ cloud-infrastructure:
+ type: object
+ $ref: "#/getDefinitions/cloud-infrastructure"
+ external-system:
+ type: object
+ $ref: "#/getDefinitions/external-system"
+ business:
+ type: object
+ $ref: "#/getDefinitions/business"
+ service-design-and-creation:
+ type: object
+ $ref: "#/getDefinitions/service-design-and-creation"
+ network:
+ type: object
+ $ref: "#/getDefinitions/network"
+ aai-internal:
+ type: object
+ $ref: "#/getDefinitions/aai-internal"
+ nodes:
+ type: array
+ items:
+ $ref: "#/getDefinitions/aai-internal"
+ inventory-item:
+ properties:
+ inventory-item-type:
+ type: string
+ inventory-item-link:
+ type: string
+ inventory-item-data:
+ type: array
+ items:
+ $ref: "#/getDefinitions/inventory-item-data"
+ tagged-inventory-item-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/tagged-inventory-item-list"
+ inventory-item-data:
+ properties:
+ property-name:
+ type: string
+ property-value:
+ type: string
+ inventory-response-item:
+ description: |
+ Inventory item for response list
+ properties:
+ model-name:
+ type: string
+ extra-properties:
+ type: object
+ $ref: "#/getDefinitions/extra-properties"
+ inventory-response-items:
+ type: object
+ $ref: "#/getDefinitions/inventory-response-items"
+ inventory-response-items:
+ description: |
+ Container for inventory items in response list
+ properties:
+ inventory-response-item:
+ type: array
+ items:
+ $ref: "#/getDefinitions/inventory-response-item"
+ ipsec-configuration:
+ 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
+ ###### Related Nodes
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
+ - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
+ - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER
+ required:
+ - ipsec-configuration-id
+ properties:
+ ipsec-configuration-id:
+ type: string
+ description: UUID of this configuration
+ requested-vig-address-type:
+ type: string
+ description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
+ requested-encryption-strength:
+ type: string
+ description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
+ requested-dmz-type:
+ type: string
+ description: ATT can offer a shared DMZ or a DMZ specific to a customer
+ shared-dmz-network-address:
+ type: string
+ description: Network address of shared DMZ
+ requested-customer-name:
+ type: string
+ description: If the DMZ is a custom DMZ, this field will indicate the customer information
+ ike-version:
+ type: string
+ description: can be 1 or 2
+ ikev1-authentication:
+ type: string
+ description: Contains values like md5, sha1, sha256, sha384
+ ikev1-encryption:
+ type: string
+ description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,ƂĀ aes-192-cbc, aes-265-cbc
+ ikev1-dh-group:
+ type: string
+ description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
+ ikev1-am-group-id:
+ type: string
+ description: Group name defined in VIG for clients using aggressive mode
+ ikev1-am-password:
+ type: string
+ description: pre-shared key for the above group name
+ ikev1-sa-lifetime:
+ type: string
+ description: Lifetime for IKEv1 SA
+ ipsec-authentication:
+ type: string
+ description: md5, sha1, sha256, sha384
+ ipsec-encryption:
+ type: string
+ description: 3des-cbc, des-cbc, aes-128-cbc,ƂĀ aes-192-cbc, aes-265-cbc
+ ipsec-sa-lifetime:
+ type: string
+ description: Life time for IPSec SA
+ ipsec-pfs:
+ type: string
+ description: enable PFS or not
+ xauth-userid:
+ type: string
+ description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName
+ xauth-user-password:
+ type: string
+ description: Encrypted using the Juniper $9$ algorithm
+ dpd-interval:
+ type: string
+ description: The time between DPD probe
+ dpd-frequency:
+ type: string
+ description: Maximum number of DPD before claiming the tunnel is down
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ vig-servers:
+ type: array
+ items:
+ $ref: "#/getDefinitions/vig-server"
+ ipsec-configurations:
+ properties:
+ ipsec-configuration:
+ type: array
+ items:
+ $ref: "#/getDefinitions/ipsec-configuration"
+ key-data:
+ properties:
+ key-name:
+ type: string
+ key-value:
+ type: string
+ l-interface:
+ description: |
+ Logical interfaces, e.g., a vnic.
+ ###### Related Nodes
+ - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
+ - TO instance-group( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
+ - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
+ - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
+ - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
+ - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
+ - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY)
+ - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
+ - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
+ - FROM configuration( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY)
+ - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
+ - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
+ - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,LOGICAL-LINK,SRIOV-VF,VLAN
+ - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
+ required:
+ - interface-name
+ - is-port-mirrored
+ - in-maint
+ - is-ip-unnumbered
+ properties:
+ interface-name:
+ type: string
+ description: Name given to the interface
+ interface-role:
+ type: string
+ description: E.g., CUSTOMER, UPLINK, etc.
+ v6-wan-link-ip:
+ type: string
+ description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
+ selflink:
+ type: string
+ description: URL to endpoint where AAI can get more details
+ interface-id:
+ type: string
+ description: ID of interface
+ macaddr:
+ type: string
+ description: MAC address for the interface
+ network-name:
+ type: string
+ description: Name of the network
+ management-option:
+ type: string
+ description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
+ interface-description:
+ type: string
+ description: Human friendly text regarding this interface.
+ is-port-mirrored:
+ type: boolean
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ in-maint:
+ type: boolean
+ prov-status:
+ type: string
+ description: Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV].
+ is-ip-unnumbered:
+ type: boolean
+ allowed-address-pairs:
+ type: string
+ description: Freeform field for storing an ip address, list of ip addresses or a subnet block.
+ vlans:
+ type: array
+ items:
+ $ref: "#/getDefinitions/vlan"
+ sriov-vfs:
+ type: array
+ items:
+ $ref: "#/getDefinitions/sriov-vf"
+ l-interfaces:
+ type: array
+ items:
+ $ref: "#/getDefinitions/l-interface"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ l3-interface-ipv4-address-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
+ l3-interface-ipv6-address-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
+ l-interfaces:
+ description: |
+ Collection of logical interfaces.
+ properties:
+ l-interface:
+ type: array
+ items:
+ $ref: "#/getDefinitions/l-interface"
+ l3-interface-ipv4-address-list:
+ description: |
+ IPv4 Address Range
+ ###### Related Nodes
+ - TO instance-group( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
+ - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
+ - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
+ - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
+ - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
+ - TO vnfc( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
+ required:
+ - l3-interface-ipv4-address
+ properties:
+ l3-interface-ipv4-address:
+ type: string
+ description: IP address
+ l3-interface-ipv4-prefix-length:
+ type: integer
+ format: int64
+ description: Prefix length, 32 for single address
+ vlan-id-inner:
+ type: integer
+ format: int64
+ description: Inner VLAN tag
+ vlan-id-outer:
+ type: integer
+ format: int64
+ description: Outer VLAN tag
+ is-floating:
+ type: boolean
+ description: Indicator of fixed or floating address
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ neutron-network-id:
+ type: string
+ description: Neutron network id of the interface that address belongs to
+ neutron-subnet-id:
+ type: string
+ description: Neutron id of subnet that address belongs to
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ l3-interface-ipv6-address-list:
+ description: |
+ IPv6 Address Range
+ ###### Related Nodes
+ - TO instance-group( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
+ - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
+ - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
+ - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
+ - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
+ - TO vnfc( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
+ required:
+ - l3-interface-ipv6-address
+ properties:
+ l3-interface-ipv6-address:
+ type: string
+ description: IP address
+ l3-interface-ipv6-prefix-length:
+ type: integer
+ format: int64
+ description: Prefix length, 128 for single address
+ vlan-id-inner:
+ type: integer
+ format: int64
+ description: Inner VLAN tag
+ vlan-id-outer:
+ type: integer
+ format: int64
+ description: Outer VLAN tag
+ is-floating:
+ type: boolean
+ description: Indicator of fixed or floating address
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ neutron-network-id:
+ type: string
+ description: Neutron network id of the interface that address belongs to
+ neutron-subnet-id:
+ type: string
+ description: Neutron id of subnet that address belongs to
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ l3-network:
+ description: |
+ Generic network definition
+ ###### Related Nodes
+ - TO instance-group( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
+ - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
+ - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
+ - TO model-ver( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One)
+ - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
+ - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
+ - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
+ - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
+ - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
+ - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
+ - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
+ - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
+ - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET
+ required:
+ - network-id
+ - network-name
+ - is-bound-to-vpn
+ - is-provider-network
+ - is-shared-network
+ - is-external-network
+ properties:
+ network-id:
+ type: string
+ description: Network ID, should be uuid. Unique across A&AI.
+ network-name:
+ type: string
+ description: Name of the network, governed by some naming convention..
+ network-type:
+ type: string
+ description: Type of the network - who defines these values?
+ network-role:
+ type: string
+ description: Role the network plans - who defines these values?
+ network-technology:
+ type: string
+ description: Network technology - who defines these values?
+ neutron-network-id:
+ type: string
+ description: Neutron network id of this Interface
+ is-bound-to-vpn:
+ type: boolean
+ service-id:
+ type: string
+ description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
+ network-role-instance:
+ type: integer
+ format: int64
+ description: network role instance
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ orchestration-status:
+ type: string
+ description: Orchestration status of this VNF, mastered by MSO
+ heat-stack-id:
+ type: string
+ description: Heat stack id corresponding to this instance, managed by MSO
+ mso-catalog-key:
+ type: string
+ description: Corresponds to the SDN-C catalog id used to configure this VCE
+ contrail-network-fqdn:
+ type: string
+ description: Contrail FQDN for the network
+ model-invariant-id:
+ type: string
+ description: the ASDC model id for this resource or service model.
+ model-version-id:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ persona-model-version:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ model-customization-id:
+ type: string
+ description: captures the id of all the configuration used to customize the resource for the service.
+ widget-model-id:
+ type: string
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ widget-model-version:
+ type: string
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ physical-network-name:
+ type: string
+ description: Name associated with the physical network.
+ is-provider-network:
+ type: boolean
+ is-shared-network:
+ type: boolean
+ is-external-network:
+ type: boolean
+ selflink:
+ type: string
+ description: Path to the controller object.
+ operational-status:
+ type: string
+ description: Indicator for whether the resource is considered operational.
+ subnets:
+ type: array
+ items:
+ $ref: "#/getDefinitions/subnet"
+ ctag-assignments:
+ type: array
+ items:
+ $ref: "#/getDefinitions/ctag-assignment"
+ segmentation-assignments:
+ type: array
+ items:
+ $ref: "#/getDefinitions/segmentation-assignment"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
+ l3-networks:
+ properties:
+ l3-network:
+ type: array
+ items:
+ $ref: "#/getDefinitions/l3-network"
+ lag-interface:
+ description: |
+ Link aggregate interface
+ ###### Related Nodes
+ - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
+ - TO logical-link( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
+ - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
+ - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
+ - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
+ - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
+ - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
+ - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
+ - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE
+ - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK
+ required:
+ - interface-name
+ - in-maint
+ properties:
+ interface-name:
+ type: string
+ description: Name that identifies the link aggregate interface
+ interface-description:
+ type: string
+ description: Human friendly text regarding this interface.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ speed-value:
+ type: string
+ description: Captures the numeric part of the speed
+ speed-units:
+ type: string
+ description: Captures the units corresponding to the speed
+ interface-id:
+ type: string
+ description: ID of interface
+ interface-role:
+ type: string
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ prov-status:
+ type: string
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ in-maint:
+ type: boolean
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ l-interfaces:
+ type: array
+ items:
+ $ref: "#/getDefinitions/l-interface"
+ lag-interfaces:
+ description: |
+ Collection of link aggregate interfaces.
+ properties:
+ lag-interface:
+ type: array
+ items:
+ $ref: "#/getDefinitions/lag-interface"
+ lag-link:
+ description: |
+ LAG links can connect lag-interfaces
+ ###### Related Nodes
+ - FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
+ required:
+ - link-name
+ properties:
+ link-name:
+ type: string
+ description: Alphabetical concatenation of lag-interface names
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ lag-links:
+ description: |
+ Collection of link aggregation connections
+ properties:
+ lag-link:
+ type: array
+ items:
+ $ref: "#/getDefinitions/lag-link"
+ license:
+ description: |
+ Metadata for license group.
+ ###### Related Nodes
+ - TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
+ required:
+ - group-uuid
+ - resource-uuid
+ properties:
+ group-uuid:
+ type: string
+ description: Unique ID for the license group the resource belongs to, should be uuid.
+ resource-uuid:
+ type: string
+ description: Unique ID of a license resource.
+ resource-version:
+ type: string
+ description: Concurrency value
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ licenses:
+ description: |
+ Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
+ properties:
+ license:
+ type: array
+ items:
+ $ref: "#/getDefinitions/license"
+ line-of-business:
+ description: |
+ describes a line-of-business
+ ###### Related Nodes
+ - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
+ required:
+ - line-of-business-name
+ properties:
+ line-of-business-name:
+ type: string
+ description: Name of the line-of-business (product)
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ lines-of-business:
+ description: |
+ Collection of lines-of-business
+ properties:
+ line-of-business:
+ type: array
+ items:
+ $ref: "#/getDefinitions/line-of-business"
+ logical-link:
+ description: |
+ Logical links generally connect l-interfaces but are used to express logical connectivity between two points
+ ###### Related Nodes
+ - TO l-interface( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY)
+ - TO l-interface( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY)
+ - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
+ - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
+ - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
+ - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
+ - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
+ - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
+ - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
+ - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
+ - TO model-ver( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One)
+ - FROM configuration( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
+ - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
+ - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
+ - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
+ - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
+ required:
+ - link-name
+ - in-maint
+ - link-type
+ properties:
+ link-name:
+ type: string
+ description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
+ in-maint:
+ type: boolean
+ link-type:
+ type: string
+ description: Type of logical link, e.g., evc
+ speed-value:
+ type: string
+ description: Captures the numeric part of the speed
+ speed-units:
+ type: string
+ description: Captures the units corresponding to the speed
+ ip-version:
+ type: string
+ description: v4, v6, or ds for dual stack
+ routing-protocol:
+ type: string
+ description: For example, static or BGP
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ model-invariant-id:
+ type: string
+ description: the ASDC model id for this resource or service model.
+ model-version-id:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ persona-model-version:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ widget-model-id:
+ type: string
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ widget-model-version:
+ type: string
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ operational-status:
+ type: string
+ description: Indication of operational status of the logical link.
+ prov-status:
+ type: string
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ link-role:
+ type: string
+ description: Indication of the network use of the logical link.
+ link-name2:
+ type: string
+ description: Alias or alternate name (CLCI or D1 name).
+ link-id:
+ type: string
+ description: UUID of the logical-link, SDNC generates this.
+ circuit-id:
+ type: string
+ description: Circuit id
+ purpose:
+ type: string
+ description: Reason for this entity, role it is playing
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ logical-links:
+ description: |
+ Collection of logical connections
+ properties:
+ logical-link:
+ type: array
+ items:
+ $ref: "#/getDefinitions/logical-link"
+ metadata:
+ description: |
+ Collection of metadatum (key/value pairs)
+ properties:
+ metadatum:
+ type: array
+ items:
+ $ref: "#/getDefinitions/metadatum"
+ metadatum:
+ description: |
+ Key/value pairs
+ ###### Related Nodes
+ - TO configuration( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
+ - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
+ - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
+ - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
+ - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
+ required:
+ - metaname
+ - metaval
+ properties:
+ metaname:
+ type: string
+ metaval:
+ type: string
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ model:
+ description: |
+ Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
+ ###### Related Nodes
+ - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
+ - FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
+ - FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
+ - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
+ - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
+ - MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
+ - MODEL is DELETED when these are DELETED MODEL-VER
+ required:
+ - model-invariant-id
+ - model-type
+ properties:
+ model-invariant-id:
+ type: string
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ model-type:
+ type: string
+ description: Type of the model, e.g., service, resource, widget, etc.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ model-vers:
+ type: array
+ items:
+ $ref: "#/getDefinitions/model-ver"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ model-and-named-query-search:
+ description: |
+ ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
+ properties:
+ query-parameters:
+ type: object
+ $ref: "#/getDefinitions/query-parameters"
+ instance-filters:
+ type: object
+ $ref: "#/getDefinitions/instance-filters"
+ secondary-filts:
+ type: object
+ $ref: "#/getDefinitions/secondary-filts"
+ top-node-type:
+ type: string
+ secondary-filter-cut-point:
+ type: string
+ model-constraint:
+ description: |
+ This is how we would capture constraints defining allowed sets of elements.
+ ###### Related Nodes
+ - TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
+ - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
+ - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET
+ required:
+ - model-constraint-uuid
+ - constrained-element-set-uuid-to-replace
+ properties:
+ model-constraint-uuid:
+ type: string
+ constrained-element-set-uuid-to-replace:
+ type: string
+ constrained-element-sets:
+ type: array
+ items:
+ $ref: "#/getDefinitions/constrained-element-set"
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ model-constraints:
+ properties:
+ model-constraint:
+ type: array
+ items:
+ $ref: "#/getDefinitions/model-constraint"
+ model-element:
+ description: |
+ Defines how other models combine to make up a higher-level model.
+ ###### Related Nodes
+ - TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
+ - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
+ - TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
+ - TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
+ - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
+ - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
+ - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
+ - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT
+ required:
+ - model-element-uuid
+ - new-data-del-flag
+ - cardinality
+ properties:
+ model-element-uuid:
+ type: string
+ new-data-del-flag:
+ type: string
+ description: Indicates whether this element was created as part of instantiation from this model
+ cardinality:
+ type: string
+ description: How many of this type of element are required/allowed
+ linkage-points:
+ type: string
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ model-elements:
+ type: array
+ items:
+ $ref: "#/getDefinitions/model-element"
+ description: Defines how other models combine to make up a higher-level model
+ model-constraints:
+ type: array
+ items:
+ $ref: "#/getDefinitions/model-constraint"
+ description: Describes new constraints on this model element that are not part of that model's definition
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ model-elements:
+ properties:
+ model-element:
+ type: array
+ items:
+ $ref: "#/getDefinitions/model-element"
+ model-ver:
+ description: |
+ Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
+ ###### Related Nodes
+ - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
+ - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
+ - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
+ - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
+ - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.IsA model-ver, Many2One)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One)
+ - FROM l3-network( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One)
+ - FROM vf-module( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One)
+ - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT
+ - MODEL-VER is DELETED when these are DELETED METADATUM,MODEL-ELEMENT
+ required:
+ - model-version-id
+ - model-name
+ - model-version
+ properties:
+ model-version-id:
+ type: string
+ description: Unique identifier corresponding to one version of a model in ASDC
+ model-name:
+ type: string
+ description: Name of the model, which can change from version to version.
+ model-version:
+ type: string
+ description: Version
+ distribution-status:
+ type: string
+ description: Distribution Status
+ model-description:
+ type: string
+ description: Description
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ model-elements:
+ type: array
+ items:
+ $ref: "#/getDefinitions/model-element"
+ metadata:
+ type: array
+ items:
+ $ref: "#/getDefinitions/metadatum"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ model-vers:
+ properties:
+ model-ver:
+ type: array
+ items:
+ $ref: "#/getDefinitions/model-ver"
+ models:
+ description: |
+ Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
+ properties:
+ model:
+ type: array
+ items:
+ $ref: "#/getDefinitions/model"
+ multicast-configuration:
+ description: |
+ ###### Related Nodes
+ - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
+ required:
+ - multicast-configuration-id
+ - multicast-protocol
+ - rp-type
+ properties:
+ multicast-configuration-id:
+ type: string
+ description: Unique id of multicast configuration.
+ multicast-protocol:
+ type: string
+ description: protocol of multicast configuration
+ rp-type:
+ type: string
+ description: rp type of multicast configuration
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ multicast-configurations:
+ description: |
+ multicast configuration of generic-vnf ip-address
+ properties:
+ multicast-configuration:
+ type: array
+ items:
+ $ref: "#/getDefinitions/multicast-configuration"
+ named-queries:
+ properties:
+ named-query:
+ type: array
+ items:
+ $ref: "#/getDefinitions/named-query"
+ named-query:
+ description: |
+ TBD
+ ###### Related Nodes
+ - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
+ - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
+ - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
+ - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT
+ required:
+ - named-query-uuid
+ - named-query-name
+ - named-query-version
+ properties:
+ named-query-uuid:
+ type: string
+ named-query-name:
+ type: string
+ named-query-version:
+ type: string
+ required-input-param:
+ type: string
+ description:
+ type: string
+ resource-version:
+ type: string
+ named-query-elements:
+ type: array
+ items:
+ $ref: "#/getDefinitions/named-query-element"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ named-query-element:
+ description: |
+ TBD
+ ###### Related Nodes
+ - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
+ - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
+ - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
+ - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
+ - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
+ - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
+ - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP
+ required:
+ - named-query-element-uuid
+ properties:
+ named-query-element-uuid:
+ type: string
+ property-collect-list:
+ type: string
+ resource-version:
+ type: string
+ property-limit-desc:
+ type: string
+ do-not-output:
+ type: string
+ named-query-elements:
+ type: array
+ items:
+ $ref: "#/getDefinitions/named-query-element"
+ related-lookups:
+ type: array
+ items:
+ $ref: "#/getDefinitions/related-lookup"
+ property-constraints:
+ type: array
+ items:
+ $ref: "#/getDefinitions/property-constraint"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ named-query-elements:
+ properties:
+ named-query-element:
+ type: array
+ items:
+ $ref: "#/getDefinitions/named-query-element"
+ network:
+ description: |
+ Namespace for network inventory resources.
+ properties:
+ logical-links:
+ type: array
+ items:
+ $ref: "#/getDefinitions/logical-link"
+ site-pair-sets:
+ type: array
+ items:
+ $ref: "#/getDefinitions/site-pair-set"
+ vpn-bindings:
+ type: array
+ items:
+ $ref: "#/getDefinitions/vpn-binding"
+ vpls-pes:
+ type: array
+ items:
+ $ref: "#/getDefinitions/vpls-pe"
+ multicast-configurations:
+ type: array
+ items:
+ $ref: "#/getDefinitions/multicast-configuration"
+ vces:
+ type: array
+ items:
+ $ref: "#/getDefinitions/vce"
+ vnfcs:
+ type: array
+ items:
+ $ref: "#/getDefinitions/vnfc"
+ l3-networks:
+ type: array
+ items:
+ $ref: "#/getDefinitions/l3-network"
+ network-policies:
+ type: array
+ items:
+ $ref: "#/getDefinitions/network-policy"
+ generic-vnfs:
+ type: array
+ items:
+ $ref: "#/getDefinitions/generic-vnf"
+ lag-links:
+ type: array
+ items:
+ $ref: "#/getDefinitions/lag-link"
+ newvces:
+ type: array
+ items:
+ $ref: "#/getDefinitions/newvce"
+ pnfs:
+ type: array
+ items:
+ $ref: "#/getDefinitions/pnf"
+ physical-links:
+ type: array
+ items:
+ $ref: "#/getDefinitions/physical-link"
+ ipsec-configurations:
+ type: array
+ items:
+ $ref: "#/getDefinitions/ipsec-configuration"
+ route-table-references:
+ type: array
+ items:
+ $ref: "#/getDefinitions/route-table-reference"
+ instance-groups:
+ type: array
+ items:
+ $ref: "#/getDefinitions/instance-group"
+ zones:
+ type: array
+ items:
+ $ref: "#/getDefinitions/zone"
+ configurations:
+ type: array
+ items:
+ $ref: "#/getDefinitions/configuration"
+ forwarding-paths:
+ type: array
+ items:
+ $ref: "#/getDefinitions/forwarding-path"
+ network-policies:
+ properties:
+ network-policy:
+ type: array
+ items:
+ $ref: "#/getDefinitions/network-policy"
+ network-policy:
+ description: |
+ ###### Related Nodes
+ - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
+ - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
+ required:
+ - network-policy-id
+ properties:
+ network-policy-id:
+ type: string
+ description: UUID representing unique key to this instance
+ network-policy-fqdn:
+ type: string
+ description: Contrail FQDN for the policy
+ heat-stack-id:
+ type: string
+ description: ID for the openStack Heat instance
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ network-profile:
+ description: |
+ Network profile populated by SDN-GP for SNMP
+ ###### Related Nodes
+ - TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
+ required:
+ - nm-profile-name
+ properties:
+ nm-profile-name:
+ type: string
+ description: Unique name of network profile.
+ community-string:
+ type: string
+ description: Encrypted SNMP community string
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ network-profiles:
+ description: |
+ Collection of network profiles
+ properties:
+ network-profile:
+ type: array
+ items:
+ $ref: "#/getDefinitions/network-profile"
+ newvce:
+ description: |
+ This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
+ ###### Related Nodes
+ - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
+ - NEWVCE is DELETED when these are DELETED L-INTERFACE
+ required:
+ - vnf-id2
+ - vnf-name
+ - vnf-type
+ properties:
+ vnf-id2:
+ type: string
+ description: Unique id of VNF, can't use same attribute name right now until we promote this new object
+ vnf-name:
+ type: string
+ description: Name of VNF.
+ vnf-name2:
+ type: string
+ description: Alternate name of VNF.
+ vnf-type:
+ type: string
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ prov-status:
+ type: string
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ operational-status:
+ type: string
+ description: Indicator for whether the resource is considered operational
+ license-key:
+ type: string
+ description: OBSOLETE - do not use
+ ipv4-oam-address:
+ type: string
+ description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
+ equipment-role:
+ type: string
+ description: Client should send valid enumerated value.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ ipv4-loopback0-address:
+ type: string
+ description: v4 Loopback0 address
+ orchestration-status:
+ type: string
+ description: Orchestration status of this VNF, mastered by MSO.
+ heat-stack-id:
+ type: string
+ description: Heat stack id corresponding to this instance, managed by MSO
+ mso-catalog-key:
+ type: string
+ description: Corresponds to the SDN-C catalog id used to configure this VCE
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ l-interfaces:
+ type: array
+ items:
+ $ref: "#/getDefinitions/l-interface"
+ newvces:
+ description: |
+ This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
+ properties:
+ newvce:
+ type: array
+ items:
+ $ref: "#/getDefinitions/newvce"
+ notification-event:
+ properties:
+ cambria.partition:
+ type: string
+ notification-event-header:
+ type: object
+ $ref: "#/getDefinitions/notification-event-header"
+ notification-event-header:
+ properties:
+ id:
+ type: string
+ timestamp:
+ type: string
+ source-name:
+ type: string
+ domain:
+ type: string
+ sequence-number:
+ type: string
+ severity:
+ type: string
+ event-type:
+ type: string
+ version:
+ type: string
+ action:
+ type: string
+ entity-type:
+ type: string
+ top-entity-type:
+ type: string
+ entity-link:
+ type: string
+ status:
+ type: string
+ notify:
+ required:
+ - event-id
+ properties:
+ event-id:
+ type: string
+ node-type:
+ type: string
+ event-trigger:
+ type: string
+ key-data:
+ type: array
+ items:
+ $ref: "#/getDefinitions/key-data"
+ selflink:
+ type: string
+ oam-network:
+ description: |
+ OAM network, to be deprecated shortly. Do not use for new purposes.
+ ###### Related Nodes
+ - TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
+ - TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
+ required:
+ - network-uuid
+ - network-name
+ - cvlan-tag
+ properties:
+ network-uuid:
+ type: string
+ description: UUID of the network. Unique across a cloud-region
+ network-name:
+ type: string
+ description: Name of the network.
+ cvlan-tag:
+ type: integer
+ format: int64
+ description: cvlan-id
+ ipv4-oam-gateway-address:
+ type: string
+ description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
+ ipv4-oam-gateway-address-prefix-length:
+ type: integer
+ format: int32
+ description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ oam-networks:
+ description: |
+ Collection of OAM networks, to be deprecated shortly. Do not use for new purposes.
+ properties:
+ oam-network:
+ type: array
+ items:
+ $ref: "#/getDefinitions/oam-network"
+ operational-environment:
+ description: |
+ It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
+ ###### Related Nodes
+ - TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
+ - FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
+ required:
+ - operational-environment-id
+ - operational-environment-name
+ - operational-environment-type
+ - operational-environment-status
+ - tenant-context
+ - workload-context
+ properties:
+ operational-environment-id:
+ type: string
+ description: UUID of an operational environment
+ operational-environment-name:
+ type: string
+ description: Operational Environment name
+ operational-environment-type:
+ type: string
+ description: Operational Environment Type.
+ operational-environment-status:
+ type: string
+ description: Status
+ tenant-context:
+ type: string
+ description: Tenant Context.
+ workload-context:
+ type: string
+ description: Workload Context.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ operational-environments:
+ description: |
+ a logical partition of the cloud which allows to have multiple environments in the production AIC.
+ properties:
+ operational-environment:
+ type: array
+ items:
+ $ref: "#/getDefinitions/operational-environment"
+ overloaded-model:
+ description: |
+ Allows for legacy POST of old-style and new-style models
+ required:
+ - model-invariant-id
+ - model-name-version-id
+ - model-type
+ - model-name
+ - model-id
+ - model-version
+ properties:
+ model-invariant-id:
+ type: string
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ model-name-version-id:
+ type: string
+ description: Unique identifier corresponding to one version of a model in ASDC
+ model-type:
+ type: string
+ description: Type of the model, e.g., service, resource, widget, etc.
+ model-name:
+ type: string
+ description: Name of the model, which can change from version to version.
+ model-id:
+ type: string
+ description: Invariant unique ID which does not change from version to version
+ model-version:
+ type: string
+ description: Version
+ model-description:
+ type: string
+ description: Description
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ model-vers:
+ type: object
+ $ref: "#/getDefinitions/model-vers"
+ relationship-list:
+ type: object
+ $ref: "#/getDefinitions/relationship-list"
+ owning-entities:
+ description: |
+ Collection of owning-entities
+ properties:
+ owning-entity:
+ type: array
+ items:
+ $ref: "#/getDefinitions/owning-entity"
+ owning-entity:
+ description: |
+ describes an owning-entity
+ ###### Related Nodes
+ - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
+ required:
+ - owning-entity-id
+ - owning-entity-name
+ properties:
+ owning-entity-id:
+ type: string
+ description: UUID of an owning entity
+ owning-entity-name:
+ type: string
+ description: Owning entity name
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ p-interface:
+ description: |
+ Physical interface (e.g., nic)
+ ###### Related Nodes
+ - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
+ - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
+ - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
+ - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
+ - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
+ - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
+ - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
+ - FROM sriov-pf( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
+ - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
+ - P-INTERFACE is DELETED when these are DELETED L-INTERFACE,SRIOV-PF
+ - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK
+ required:
+ - interface-name
+ - in-maint
+ properties:
+ interface-name:
+ type: string
+ description: Name that identifies the physical interface
+ selflink:
+ type: string
+ description: URL to endpoint where AAI can get more details.
+ speed-value:
+ type: string
+ description: Captures the numeric part of the speed
+ speed-units:
+ type: string
+ description: Captures the units corresponding to the speed
+ port-description:
+ type: string
+ description: Nature of the services and connectivity on this port.
+ equipment-identifier:
+ type: string
+ description: CLEI or other specification for p-interface hardware.
+ interface-role:
+ type: string
+ description: Role specification for p-interface hardware.
+ interface-type:
+ type: string
+ description: Indicates the physical properties of the interface.
+ prov-status:
+ type: string
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ mac-addresss:
+ type: string
+ description: MAC Address of the p-interface.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ in-maint:
+ type: boolean
+ inv-status:
+ type: string
+ description: inventory status
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ sriov-pfs:
+ type: array
+ items:
+ $ref: "#/getDefinitions/sriov-pf"
+ l-interfaces:
+ type: array
+ items:
+ $ref: "#/getDefinitions/l-interface"
+ p-interfaces:
+ description: |
+ Collection of physical interfaces.
+ properties:
+ p-interface:
+ type: array
+ items:
+ $ref: "#/getDefinitions/p-interface"
+ physical-link:
+ description: |
+ Collection of physical connections, typically between p-interfaces
+ ###### Related Nodes
+ - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
+ required:
+ - link-name
+ properties:
+ link-name:
+ type: string
+ description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
+ speed-value:
+ type: string
+ description: Captures the numeric part of the speed
+ speed-units:
+ type: string
+ description: Captures the units corresponding to the speed
+ circuit-id:
+ type: string
+ description: Circuit it
+ dual-mode:
+ type: string
+ description: Dual access mode (e.g., primary, secondary
+ management-option:
+ type: string
+ description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
+ service-provider-name:
+ type: string
+ description: Name of the service Provider on this link.
+ service-provider-bandwidth-up-value:
+ type: integer
+ format: int32
+ description: Upstream Bandwidth value agreed with the service provider
+ service-provider-bandwidth-up-units:
+ type: string
+ description: Units for the upstream BW value
+ service-provider-bandwidth-down-value:
+ type: integer
+ format: int32
+ description: Downstream Bandwidth value agreed with the service provider
+ service-provider-bandwidth-down-units:
+ type: string
+ description: Units for downstream BW value
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ physical-links:
+ description: |
+ Collection of physical connections, typically between p-interfaces
+ properties:
+ physical-link:
+ type: array
+ items:
+ $ref: "#/getDefinitions/physical-link"
+ platform:
+ description: |
+ describes a platform
+ ###### Related Nodes
+ - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
+ required:
+ - platform-name
+ properties:
+ platform-name:
+ type: string
+ description: Name of the platform
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ platforms:
+ description: |
+ Collection of platforms
+ properties:
+ platform:
+ type: array
+ items:
+ $ref: "#/getDefinitions/platform"
+ pnf:
+ 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.
+ ###### Related Nodes
+ - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
+ - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc has pnf, One2Many)
+ - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
+ - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
+ - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
+ - FROM configuration( configuration org.onap.relationships.inventory.AppliesTo pnf, ONE2MANY)
+ - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
+ required:
+ - pnf-name
+ - in-maint
+ properties:
+ pnf-name:
+ type: string
+ description: unique name of Physical Network Function.
+ pnf-name2:
+ type: string
+ description: name of Physical Network Function.
+ selflink:
+ type: string
+ description: URL to endpoint where AAI can get more details.
+ pnf-name2-source:
+ type: string
+ description: source of name2
+ pnf-id:
+ type: string
+ description: id of pnf
+ equip-type:
+ type: string
+ description: Equipment type. Source of truth should define valid values.
+ equip-vendor:
+ type: string
+ description: Equipment vendor. Source of truth should define valid values.
+ equip-model:
+ type: string
+ description: Equipment model. Source of truth should define valid values.
+ management-option:
+ type: string
+ description: identifier of managed by ATT or customer
+ ipaddress-v4-oam:
+ type: string
+ description: ipv4-oam-address with new naming convention for IP addresses
+ sw-version:
+ type: string
+ description: sw-version is the version of SW for the hosted application on the PNF.
+ in-maint:
+ type: boolean
+ frame-id:
+ type: string
+ description: ID of the physical frame (relay rack) where pnf is installed.
+ serial-number:
+ type: string
+ description: Serial number of the device
+ ipaddress-v4-loopback-0:
+ type: string
+ description: IPV4 Loopback 0 address
+ ipaddress-v6-loopback-0:
+ type: string
+ description: IPV6 Loopback 0 address
+ ipaddress-v4-aim:
+ type: string
+ description: IPV4 AIM address
+ ipaddress-v6-aim:
+ type: string
+ description: IPV6 AIM address
+ ipaddress-v6-oam:
+ type: string
+ description: IPV6 OAM address
+ inv-status:
+ type: string
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ prov-status:
+ type: string
+ description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
+ nf-role:
+ type: string
+ description: Nf Role is the role performed by this instance in the network.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ p-interfaces:
+ type: array
+ items:
+ $ref: "#/getDefinitions/p-interface"
+ lag-interfaces:
+ type: array
+ items:
+ $ref: "#/getDefinitions/lag-interface"
+ pnfs:
+ description: |
+ Collection of Physical Network Functions.
+ properties:
+ pnf:
+ type: array
+ items:
+ $ref: "#/getDefinitions/pnf"
+ port-group:
+ description: |
+ Used to capture the network interfaces of this VCE
+ ###### Related Nodes
+ - TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
+ - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE)
+ - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG
+ required:
+ - interface-id
+ - orchestration-status
+ properties:
+ interface-id:
+ type: string
+ description: Unique ID of the interface
+ neutron-network-id:
+ type: string
+ description: Neutron network id of this Interface
+ neutron-network-name:
+ type: string
+ description: Neutron network name of this Interface
+ interface-role:
+ type: string
+ description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ port-group-id:
+ type: string
+ description: Unique ID for port group in vmware
+ port-group-name:
+ type: string
+ description: Likely to duplicate value of neutron network name
+ switch-name:
+ type: string
+ description: DVS or standard switch name (should be non-null for port groups associated with DVS)
+ orchestration-status:
+ type: string
+ description: Orchestration status of this VNF, mastered by MSO
+ heat-stack-id:
+ type: string
+ description: Heat stack id corresponding to this instance, managed by MSO
+ mso-catalog-key:
+ type: string
+ description: Corresponds to the SDN-C catalog id used to configure this VCE
+ cvlan-tags:
+ type: array
+ items:
+ $ref: "#/getDefinitions/cvlan-tag-entry"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ port-groups:
+ properties:
+ port-group:
+ type: array
+ items:
+ $ref: "#/getDefinitions/port-group"
+ project:
+ description: |
+ describes the project
+ ###### Related Nodes
+ - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
+ required:
+ - project-name
+ properties:
+ project-name:
+ type: string
+ description: Name of the project deploying a service
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ projects:
+ description: |
+ Collection of projects
+ properties:
+ project:
+ type: array
+ items:
+ $ref: "#/getDefinitions/project"
+ properties:
+ description: |
+ Property holder for query properties or instance properties
+ properties:
+ property-name:
+ type: string
+ property-value:
+ type: string
+ property-constraint:
+ description: |
+ TBD
+ ###### Related Nodes
+ - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
+ required:
+ - property-constraint-uuid
+ - constraint-type
+ - property-name
+ - property-value
+ properties:
+ property-constraint-uuid:
+ type: string
+ constraint-type:
+ type: string
+ property-name:
+ type: string
+ property-value:
+ type: string
+ resource-version:
+ type: string
+ property-constraints:
+ properties:
+ property-constraint:
+ type: array
+ items:
+ $ref: "#/getDefinitions/property-constraint"
+ pserver:
+ description: |
+ Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
+ ###### Related Nodes
+ - TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
+ - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
+ - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
+ - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
+ - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
+ - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
+ - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
+ - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
+ - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER
+ - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
+ - PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT
+ required:
+ - hostname
+ - in-maint
+ properties:
+ hostname:
+ type: string
+ description: Value from executing hostname on the compute node.
+ ptnii-equip-name:
+ type: string
+ description: PTNII name
+ number-of-cpus:
+ type: integer
+ format: int32
+ description: Number of cpus
+ disk-in-gigabytes:
+ type: integer
+ format: int32
+ description: Disk size, in GBs
+ ram-in-megabytes:
+ type: integer
+ format: int32
+ description: RAM size, in MBs
+ equip-type:
+ type: string
+ description: Equipment type. Source of truth should define valid values.
+ equip-vendor:
+ type: string
+ description: Equipment vendor. Source of truth should define valid values.
+ equip-model:
+ type: string
+ description: Equipment model. Source of truth should define valid values.
+ fqdn:
+ type: string
+ description: Fully-qualified domain name
+ pserver-selflink:
+ type: string
+ description: URL to endpoint where AAI can get more details
+ ipv4-oam-address:
+ type: string
+ description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
+ serial-number:
+ type: string
+ description: Serial number, may be queried
+ ipaddress-v4-loopback-0:
+ type: string
+ description: IPV4 Loopback 0 address
+ ipaddress-v6-loopback-0:
+ type: string
+ description: IPV6 Loopback 0 address
+ ipaddress-v4-aim:
+ type: string
+ description: IPV4 AIM address
+ ipaddress-v6-aim:
+ type: string
+ description: IPV6 AIM address
+ ipaddress-v6-oam:
+ type: string
+ description: IPV6 OAM address
+ inv-status:
+ type: string
+ description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
+ pserver-id:
+ type: string
+ description: ID of Pserver
+ internet-topology:
+ type: string
+ description: internet topology of Pserver
+ in-maint:
+ type: boolean
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ pserver-name2:
+ type: string
+ description: alternative pserver name
+ purpose:
+ type: string
+ description: purpose of pserver
+ prov-status:
+ type: string
+ description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
+ management-option:
+ type: string
+ description: Indicates who owns and or manages the device.
+ host-profile:
+ type: string
+ description: The host profile that defines the configuration of the pserver.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ p-interfaces:
+ type: array
+ items:
+ $ref: "#/getDefinitions/p-interface"
+ lag-interfaces:
+ type: array
+ items:
+ $ref: "#/getDefinitions/lag-interface"
+ pservers:
+ description: |
+ Collection of compute hosts.
+ properties:
+ pserver:
+ type: array
+ items:
+ $ref: "#/getDefinitions/pserver"
+ query-parameters:
+ description: |
+ QueryParameters for performing a named-query or model query
+ properties:
+ named-query:
+ type: object
+ $ref: "#/getDefinitions/named-query"
+ overloaded-model:
+ type: object
+ $ref: "#/getDefinitions/overloaded-model"
+ related-lookup:
+ description: |
+ TBD
+ ###### Related Nodes
+ - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
+ required:
+ - related-lookup-uuid
+ - source-node-type
+ - source-node-property
+ - target-node-type
+ - target-node-property
+ properties:
+ related-lookup-uuid:
+ type: string
+ source-node-type:
+ type: string
+ source-node-property:
+ type: string
+ target-node-type:
+ type: string
+ target-node-property:
+ type: string
+ property-collect-list:
+ type: string
+ resource-version:
+ type: string
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ related-lookups:
+ properties:
+ related-lookup:
+ type: array
+ items:
+ $ref: "#/getDefinitions/related-lookup"
+ related-to-property:
+ properties:
+ property-key:
+ type: string
+ description: Key part of a key/value pair
+ property-value:
+ type: string
+ description: Value part of a key/value pair
+ relationship:
+ properties:
+ related-to:
+ type: string
+ description: A keyword provided by A&AI to indicate type of node.
+ relationship-label:
+ type: string
+ description: The edge label for this relationship.
+ related-link:
+ type: string
+ description: URL to the object in A&AI.
+ relationship-data:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship-data"
+ related-to-property:
+ type: array
+ items:
+ $ref: "#/getDefinitions/related-to-property"
+ relationship-data:
+ required:
+ - relationship-key
+ - relationship-value
+ properties:
+ relationship-key:
+ type: string
+ description: A keyword provided by A&AI to indicate an attribute.
+ relationship-value:
+ type: string
+ description: Value of the attribute.
+ relationship-list:
+ properties:
+ relationship:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ reserved-prop-names:
+ description: |
+ Internal map to define some reserved properties of a vertex
+ properties:
+ last-mod-source-of-truth:
+ type: string
+ aai-node-type:
+ type: string
+ aai-created-ts:
+ type: integer
+ format: int64
+ aai-unique-key:
+ type: string
+ aai-last-mod-ts:
+ type: integer
+ format: int64
+ source-of-truth:
+ type: string
+ aai-uri:
+ type: string
+ response-list:
+ description: |
+ Response container for the results of a named-query or model query
+ properties:
+ inventory-response-items:
+ type: object
+ $ref: "#/getDefinitions/inventory-response-items"
+ result-data:
+ properties:
+ resource-type:
+ type: string
+ description: The specific type of node in the A&AI graph
+ resource-link:
+ type: string
+ description: The URL to the specific resource
+ route-table-reference:
+ description: |
+ Openstack route table reference.
+ ###### Related Nodes
+ - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
+ required:
+ - route-table-reference-id
+ - route-table-reference-fqdn
+ properties:
+ route-table-reference-id:
+ type: string
+ description: Route Table Reference id, UUID assigned to this instance.
+ route-table-reference-fqdn:
+ type: string
+ description: FQDN entry in the route table.
+ resource-version:
+ type: string
+ description: Concurrency value
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ route-table-references:
+ description: |
+ Collection of openstack route table references
+ properties:
+ route-table-reference:
+ type: array
+ items:
+ $ref: "#/getDefinitions/route-table-reference"
+ route-target:
+ description: |
+ Route target information
+ ###### Related Nodes
+ - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
+ required:
+ - global-route-target
+ - route-target-role
+ properties:
+ global-route-target:
+ type: string
+ description: Number used to identify an RT, globally unique in the network
+ route-target-role:
+ type: string
+ description: Role assigned to this route target
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ route-targets:
+ description: |
+ Collection of route target information
+ properties:
+ route-target:
+ type: array
+ items:
+ $ref: "#/getDefinitions/route-target"
+ routing-instance:
+ description: |
+ ###### Related Nodes
+ - TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
+ - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
+ - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR
+ required:
+ - routing-instance-id
+ properties:
+ routing-instance-id:
+ type: string
+ description: Unique id of routing instance
+ rpm-owner:
+ type: string
+ description: rpm owner
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ site-pairs:
+ type: array
+ items:
+ $ref: "#/getDefinitions/site-pair"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ routing-instances:
+ description: |
+ set of probes related to generic-vnf routing instance
+ properties:
+ routing-instance:
+ type: array
+ items:
+ $ref: "#/getDefinitions/routing-instance"
+ sdn-zone-response:
+ properties:
+ oam-networks:
+ type: object
+ $ref: "#/getDefinitions/oam-networks"
+ az-and-dvs-switches:
+ type: array
+ items:
+ $ref: "#/getDefinitions/az-and-dvs-switches"
+ search:
+ properties:
+ edge-tag-query-result:
+ type: object
+ $ref: "#/getDefinitions/edge-tag-query-result"
+ edge-tag-query-request:
+ type: object
+ $ref: "#/getDefinitions/edge-tag-query-request"
+ search-results:
+ type: object
+ $ref: "#/getDefinitions/search-results"
+ sdn-zone-response:
+ type: object
+ $ref: "#/getDefinitions/sdn-zone-response"
+ search-results:
+ properties:
+ result-data:
+ type: array
+ items:
+ $ref: "#/getDefinitions/result-data"
+ secondary-filt:
+ description: |
+ SecondaryFilt for performing a named-query or model query
+ secondary-filter:
+ properties:
+ property-name:
+ type: string
+ filter-type:
+ type: string
+ property-value:
+ type: string
+ secondary-filts:
+ description: |
+ SecondaryFilts for performing a named-query or model query
+ properties:
+ secondary-filt:
+ type: array
+ items:
+ $ref: "#/getDefinitions/secondary-filt"
+ segmentation-assignment:
+ description: |
+ Openstack segmentation assignment.
+ ###### Related Nodes
+ - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
+ required:
+ - segmentation-id
+ properties:
+ segmentation-id:
+ type: string
+ description: Route Table Reference id, UUID assigned to this instance.
+ resource-version:
+ type: string
+ description: Concurrency value
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ segmentation-assignments:
+ description: |
+ Collection of openstack segmentation assignments
+ properties:
+ segmentation-assignment:
+ type: array
+ items:
+ $ref: "#/getDefinitions/segmentation-assignment"
+ service:
+ description: |
+ Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services.
+ required:
+ - service-id
+ - service-description
+ properties:
+ service-id:
+ type: string
+ description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
+ service-description:
+ type: string
+ description: Description of the service
+ service-selflink:
+ type: string
+ description: URL to endpoint where AAI can get more details
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ service-version:
+ type: string
+ description: service version
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ service-capabilities:
+ description: |
+ Collection of service capabilities.
+ properties:
+ service-capability:
+ type: array
+ items:
+ $ref: "#/getDefinitions/service-capability"
+ service-capability:
+ description: |
+ Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this.
+ ###### Related Nodes
+ - FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
+ - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
+ - SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK
+ required:
+ - service-type
+ - vnf-type
+ properties:
+ service-type:
+ type: string
+ description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
+ vnf-type:
+ type: string
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ service-design-and-creation:
+ description: |
+ Namespace for objects managed by ASDC
+ properties:
+ vnf-images:
+ type: array
+ items:
+ $ref: "#/getDefinitions/vnf-image"
+ services:
+ type: array
+ items:
+ $ref: "#/getDefinitions/service"
+ service-capabilities:
+ type: array
+ items:
+ $ref: "#/getDefinitions/service-capability"
+ models:
+ type: array
+ items:
+ $ref: "#/getDefinitions/model"
+ named-queries:
+ type: array
+ items:
+ $ref: "#/getDefinitions/named-query"
+ service-instance:
+ description: |
+ Instance of a service
+ ###### Related Nodes
+ - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
+ - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
+ - TO owning-entity( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
+ - TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
+ - TO configuration( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
+ - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
+ - TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
+ - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY)
+ - TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
+ - TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
+ - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
+ - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
+ - TO zone( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
+ - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
+ - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
+ - TO model-ver( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One)
+ - FROM project( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
+ - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
+ - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
+ - FROM forwarding-path( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
+ - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM,FORWARDING-PATH
+ - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
+ required:
+ - service-instance-id
+ - service-type
+ - service-role
+ - created-at
+ - updated-at
+ - description
+ properties:
+ service-instance-id:
+ type: string
+ description: Uniquely identifies this instance of a service
+ service-instance-name:
+ type: string
+ description: This field will store a name assigned to the service-instance.
+ service-type:
+ type: string
+ description: String capturing type of service.
+ service-role:
+ type: string
+ description: String capturing the service role.
+ environment-context:
+ type: string
+ description: This field will store the environment context assigned to the service-instance.
+ workload-context:
+ type: string
+ description: This field will store the workload context assigned to the service-instance.
+ created-at:
+ type: string
+ description: create time of Network Service.
+ updated-at:
+ type: string
+ description: last update of Network Service.
+ description:
+ type: string
+ description: short description for service-instance.
+ model-invariant-id:
+ type: string
+ description: the ASDC model id for this resource or service model.
+ model-version-id:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ persona-model-version:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ widget-model-id:
+ type: string
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ widget-model-version:
+ type: string
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ bandwidth-total:
+ type: string
+ description: Indicates the total bandwidth to be used for this service.
+ bandwidth-up-wan1:
+ type: string
+ description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
+ bandwidth-down-wan1:
+ type: string
+ description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
+ bandwidth-up-wan2:
+ type: string
+ description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
+ bandwidth-down-wan2:
+ type: string
+ description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
+ vhn-portal-url:
+ type: string
+ description: URL customers will use to access the vHN Portal.
+ service-instance-location-id:
+ type: string
+ description: An identifier that customers assign to the location where this service is being used.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ selflink:
+ type: string
+ description: Path to the controller object.
+ orchestration-status:
+ type: string
+ description: Orchestration status of this service.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ metadata:
+ type: array
+ items:
+ $ref: "#/getDefinitions/metadatum"
+ allotted-resources:
+ type: array
+ items:
+ $ref: "#/getDefinitions/allotted-resource"
+ service-instances:
+ description: |
+ Collection of service instances
+ properties:
+ service-instance:
+ type: array
+ items:
+ $ref: "#/getDefinitions/service-instance"
+ service-subscription:
+ description: |
+ Object that group service instances.
+ ###### Related Nodes
+ - TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
+ - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
+ - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE
+ required:
+ - service-type
+ properties:
+ service-type:
+ type: string
+ description: Value defined by orchestration to identify this service across ECOMP.
+ temp-ub-sub-account-id:
+ type: string
+ description: This property will be deleted from A&AI in the near future. Only stop gap solution.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ service-instances:
+ type: array
+ items:
+ $ref: "#/getDefinitions/service-instance"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ service-subscriptions:
+ description: |
+ Collection of objects that group service instances.
+ properties:
+ service-subscription:
+ type: array
+ items:
+ $ref: "#/getDefinitions/service-subscription"
+ services:
+ description: |
+ Collection of service model definitions. Likely to be deprecated in favor of models from ASDC.
+ properties:
+ service:
+ type: array
+ items:
+ $ref: "#/getDefinitions/service"
+ site-pair:
+ description: |
+ ###### Related Nodes
+ - TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
+ - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
+ - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE
+ required:
+ - site-pair-id
+ properties:
+ site-pair-id:
+ type: string
+ description: unique identifier of probe
+ source-ip:
+ type: string
+ description: Prefix address
+ destination-ip:
+ type: string
+ description: Prefix address
+ ip-version:
+ type: string
+ description: ip version, v4, v6
+ destination-hostname:
+ type: string
+ description: Hostname of the destination equipment to which SLAs are measured against.
+ destination-equip-type:
+ type: string
+ description: The type of destinatination equipment. Could be Router, UCPE, etc.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ classes-of-service:
+ type: array
+ items:
+ $ref: "#/getDefinitions/class-of-service"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ site-pair-set:
+ description: |
+ Set of instances for probes used to measure service level agreements
+ ###### Related Nodes
+ - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
+ - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
+ - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE
+ required:
+ - site-pair-set-id
+ properties:
+ site-pair-set-id:
+ type: string
+ description: Unique id of site pair set.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ routing-instances:
+ type: array
+ items:
+ $ref: "#/getDefinitions/routing-instance"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ site-pair-sets:
+ description: |
+ Collection of sets of instances for probes related to generic-vnf
+ properties:
+ site-pair-set:
+ type: array
+ items:
+ $ref: "#/getDefinitions/site-pair-set"
+ site-pairs:
+ description: |
+ probe within a set
+ properties:
+ site-pair:
+ type: array
+ items:
+ $ref: "#/getDefinitions/site-pair"
+ snapshot:
+ description: |
+ Openstack snapshot
+ ###### Related Nodes
+ - TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
+ required:
+ - snapshot-id
+ properties:
+ snapshot-id:
+ type: string
+ description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
+ snapshot-name:
+ type: string
+ description: Snapshot name
+ snapshot-architecture:
+ type: string
+ description: Operating system architecture
+ snapshot-os-distro:
+ type: string
+ description: The common name of the operating system distribution in lowercase
+ snapshot-os-version:
+ type: string
+ description: The operating system version as specified by the distributor.
+ application:
+ type: string
+ description: The application that the image instantiates.
+ application-vendor:
+ type: string
+ description: The vendor of the application.
+ application-version:
+ type: string
+ description: The version of the application.
+ snapshot-selflink:
+ type: string
+ description: URL to endpoint where AAI can get more details
+ prev-snapshot-id:
+ type: string
+ description: This field contains the UUID of the previous snapshot (if any).
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ snapshots:
+ description: |
+ Collection of openstack snapshots
+ properties:
+ snapshot:
+ type: array
+ items:
+ $ref: "#/getDefinitions/snapshot"
+ sriov-pf:
+ description: |
+ SR-IOV Physical Function
+ ###### Related Nodes
+ - TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
+ - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
+ required:
+ - pf-pci-id
+ properties:
+ pf-pci-id:
+ type: string
+ description: Identifier for the sriov-pf
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ sriov-pfs:
+ description: |
+ Collection of SR-IOV Physical Functions.
+ properties:
+ sriov-pf:
+ type: array
+ items:
+ $ref: "#/getDefinitions/sriov-pf"
+ sriov-vf:
+ description: |
+ SR-IOV Virtual Function (not to be confused with virtual network function)
+ ###### Related Nodes
+ - TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
+ - TO sriov-pf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
+ required:
+ - pci-id
+ properties:
+ pci-id:
+ type: string
+ description: PCI ID used to identify the sriov-vf
+ vf-vlan-filter:
+ type: string
+ description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
+ vf-mac-filter:
+ type: string
+ description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
+ vf-vlan-strip:
+ type: boolean
+ description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
+ vf-vlan-anti-spoof-check:
+ type: boolean
+ description: This option ensures anti VLAN spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.
+ vf-mac-anti-spoof-check:
+ type: boolean
+ description: This option ensures anti MAC spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.
+ vf-mirrors:
+ type: string
+ description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
+ vf-broadcast-allow:
+ type: boolean
+ description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
+ vf-unknown-multicast-allow:
+ type: boolean
+ description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
+ vf-unknown-unicast-allow:
+ type: boolean
+ description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
+ vf-insert-stag:
+ type: boolean
+ description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
+ vf-link-status:
+ type: string
+ description: This option is used to set the link status. Valid values as of 1607 are on, off, and auto.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ neutron-network-id:
+ type: string
+ description: Neutron network id of the interface
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ sriov-vfs:
+ description: |
+ Collection of SR-IOV Virtual Functions.
+ properties:
+ sriov-vf:
+ type: array
+ items:
+ $ref: "#/getDefinitions/sriov-vf"
+ start-node-filter:
+ properties:
+ property-name:
+ type: string
+ property-value:
+ type: string
+ subnet:
+ description: |
+ ###### Related Nodes
+ - TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
+ - FROM host-route( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
+ - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
+ - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
+ - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST
+ - SUBNET is DELETED when these are DELETED HOST-ROUTE
+ required:
+ - subnet-id
+ - dhcp-enabled
+ properties:
+ subnet-id:
+ type: string
+ description: Subnet ID, should be UUID.
+ subnet-name:
+ type: string
+ description: Name associated with the subnet.
+ neutron-subnet-id:
+ type: string
+ description: Neutron id of this subnet
+ gateway-address:
+ type: string
+ description: gateway ip address
+ network-start-address:
+ type: string
+ description: network start address
+ cidr-mask:
+ type: string
+ description: cidr mask
+ ip-version:
+ type: string
+ description: ip version
+ orchestration-status:
+ type: string
+ description: Orchestration status of this VNF, mastered by MSO
+ dhcp-enabled:
+ type: boolean
+ dhcp-start:
+ type: string
+ description: the start address reserved for use by dhcp
+ dhcp-end:
+ type: string
+ description: the last address reserved for use by dhcp
+ subnet-role:
+ type: string
+ description: role of the subnet, referenced when assigning IPs
+ ip-assignment-direction:
+ type: string
+ description: ip address assignment direction of the subnet
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ subnet-sequence:
+ type: integer
+ format: int32
+ description: sequence of the subnet
+ host-routes:
+ type: array
+ items:
+ $ref: "#/getDefinitions/host-route"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ subnets:
+ properties:
+ subnet:
+ type: array
+ items:
+ $ref: "#/getDefinitions/subnet"
+ tagged-inventory-item-list:
+ properties:
+ inventory-item:
+ type: array
+ items:
+ $ref: "#/getDefinitions/inventory-item"
+ tenant:
+ description: |
+ Openstack tenant
+ ###### Related Nodes
+ - TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
+ - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
+ - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
+ - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
+ - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
+ - TENANT cannot be deleted if linked to VSERVER
+ required:
+ - tenant-id
+ - tenant-name
+ properties:
+ tenant-id:
+ type: string
+ description: Unique id relative to the cloud-region.
+ tenant-name:
+ type: string
+ description: Readable name of tenant
+ tenant-context:
+ type: string
+ description: This field will store the tenant context.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ vservers:
+ type: array
+ items:
+ $ref: "#/getDefinitions/vserver"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ tenants:
+ description: |
+ Collection of openstack tenants.
+ properties:
+ tenant:
+ type: array
+ items:
+ $ref: "#/getDefinitions/tenant"
+ tunnel-xconnect:
+ description: |
+ Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
+ ###### Related Nodes
+ - TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
+ required:
+ - id
+ properties:
+ id:
+ type: string
+ description: Allotted Resource id UUID assigned to this instance.
+ bandwidth-up-wan1:
+ type: string
+ description: The WAN uplink bandwidth for WAN1
+ bandwidth-down-wan1:
+ type: string
+ description: The WAN downlink bandwidth for WAN1
+ bandwidth-up-wan2:
+ type: string
+ description: The WAN uplink bandwidth for WAN2
+ bandwidth-down-wan2:
+ type: string
+ description: The WAN downlink bandwidth for WAN2
+ resource-version:
+ type: string
+ description: Concurrency value
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ tunnel-xconnects:
+ description: |
+ This object is used to store the specific tunnel cross connect aspects of an allotted resource
+ properties:
+ tunnel-xconnect:
+ type: array
+ items:
+ $ref: "#/getDefinitions/tunnel-xconnect"
+ update:
+ description: |
+ Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team.
+ required:
+ - update-node-type
+ properties:
+ update-node-type:
+ type: string
+ update-node-key:
+ type: array
+ items:
+ $ref: "#/getDefinitions/update-node-key"
+ update-node-uri:
+ type: string
+ action:
+ type: array
+ items:
+ $ref: "#/getDefinitions/action"
+ update-node-key:
+ properties:
+ key-name:
+ type: string
+ key-value:
+ type: string
+ vce:
+ description: |
+ Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated.
+ ###### Related Nodes
+ - TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
+ - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
+ - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY)
+ - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
+ - FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
+ - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
+ - VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP
+ required:
+ - vnf-id
+ - vnf-name
+ - vnf-type
+ properties:
+ vnf-id:
+ type: string
+ description: Unique id of VNF. This is unique across the graph.
+ vnf-name:
+ type: string
+ description: Name of VNF.
+ vnf-name2:
+ type: string
+ description: Alternate name of VNF.
+ vnf-type:
+ type: string
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ service-id:
+ type: string
+ description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
+ regional-resource-zone:
+ type: string
+ description: Regional way of organizing pservers, source of truth should define values
+ prov-status:
+ type: string
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ operational-status:
+ type: string
+ description: Indicator for whether the resource is considered operational
+ license-key:
+ type: string
+ description: OBSOLETE - do not use
+ equipment-role:
+ type: string
+ description: Network role being played by this VNF
+ orchestration-status:
+ type: string
+ description: Orchestration status of this VNF, mastered by MSO
+ heat-stack-id:
+ type: string
+ description: Heat stack id corresponding to this instance, managed by MSO
+ mso-catalog-key:
+ type: string
+ description: Corresponds to the SDN-C catalog id used to configure this VCE
+ vpe-id:
+ type: string
+ description: Unique ID of VPE connected to this VCE.
+ v6-vce-wan-address:
+ type: string
+ description: Valid v6 IP address for the WAN Link on this router. Implied length of /64.
+ ipv4-oam-address:
+ type: string
+ description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ ipv4-loopback0-address:
+ type: string
+ description: Loopback0 address
+ entitlement-resource-uuid:
+ type: string
+ description: OBSOLETE - see child relationships
+ port-groups:
+ type: array
+ items:
+ $ref: "#/getDefinitions/port-group"
+ licenses:
+ type: array
+ items:
+ $ref: "#/getDefinitions/license"
+ entitlements:
+ type: array
+ items:
+ $ref: "#/getDefinitions/entitlement"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ vces:
+ description: |
+ Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated.
+ properties:
+ vce:
+ type: array
+ items:
+ $ref: "#/getDefinitions/vce"
+ vf-module:
+ description: |
+ a deployment unit of VNFCs
+ ###### Related Nodes
+ - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
+ - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
+ - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
+ - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
+ - TO model-ver( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One)
+ - VF-MODULE cannot be deleted if linked to VNFC
+ required:
+ - vf-module-id
+ - is-base-vf-module
+ properties:
+ vf-module-id:
+ type: string
+ description: Unique ID of vf-module.
+ vf-module-name:
+ type: string
+ description: Name of vf-module
+ heat-stack-id:
+ type: string
+ description: Heat stack id corresponding to this instance.
+ orchestration-status:
+ type: string
+ description: orchestration status of this vf-module, mastered by MSO
+ is-base-vf-module:
+ type: boolean
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ model-invariant-id:
+ type: string
+ description: the ASDC model id for this resource or service model.
+ model-version-id:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ persona-model-version:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ model-customization-id:
+ type: string
+ description: captures the id of all the configuration used to customize the resource for the service.
+ widget-model-id:
+ type: string
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ widget-model-version:
+ type: string
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ contrail-service-instance-fqdn:
+ type: string
+ description: the Contrail unique ID for a service-instance
+ module-index:
+ type: integer
+ format: int32
+ description: the index will track the number of modules of a given type that have been deployed in a VNF, starting with 0, and always choosing the lowest available digit
+ selflink:
+ type: string
+ description: Path to the controller object.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ vf-modules:
+ description: |
+ Collection of vf-modules, a deployment unit of VNFCs
+ properties:
+ vf-module:
+ type: array
+ items:
+ $ref: "#/getDefinitions/vf-module"
+ vig-server:
+ description: |
+ vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
+ ###### Related Nodes
+ - TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
+ required:
+ - vig-address-type
+ properties:
+ vig-address-type:
+ type: string
+ description: indicates whether the VIG is for AVPN or INTERNET
+ ipaddress-v4-vig:
+ type: string
+ description: v4 IP of the vig server
+ ipaddress-v6-vig:
+ type: string
+ description: v6 IP of the vig server
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ vig-servers:
+ properties:
+ vig-server:
+ type: array
+ items:
+ $ref: "#/getDefinitions/vig-server"
+ vip-ipv4-address-list:
+ description: |
+ IPv4 Address Range
+ ###### Related Nodes
+ - TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
+ - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
+ required:
+ - vip-ipv4-address
+ properties:
+ vip-ipv4-address:
+ type: string
+ description: IP address
+ vip-ipv4-prefix-length:
+ type: integer
+ format: int64
+ description: Prefix length, 32 for single address
+ vlan-id-inner:
+ type: integer
+ format: int64
+ description: Inner VLAN tag
+ vlan-id-outer:
+ type: integer
+ format: int64
+ description: Outer VLAN tag
+ is-floating:
+ type: boolean
+ description: Indicator of fixed or floating address
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ neutron-network-id:
+ type: string
+ description: Neutron network id of the interface that address belongs to
+ neutron-subnet-id:
+ type: string
+ description: Neutron id of subnet that address belongs to
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ vip-ipv6-address-list:
+ description: |
+ IPv6 Address Range
+ ###### Related Nodes
+ - TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
+ - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
+ required:
+ - vip-ipv6-address
+ properties:
+ vip-ipv6-address:
+ type: string
+ description: IP address
+ vip-ipv6-prefix-length:
+ type: integer
+ format: int64
+ description: Prefix length, 128 for single address
+ vlan-id-inner:
+ type: integer
+ format: int64
+ description: Inner VLAN tag
+ vlan-id-outer:
+ type: integer
+ format: int64
+ description: Outer VLAN tag
+ is-floating:
+ type: boolean
+ description: Indicator of fixed or floating address
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ neutron-network-id:
+ type: string
+ description: Neutron network id of the interface that address belongs to
+ neutron-subnet-id:
+ type: string
+ description: Neutron id of subnet that address belongs to
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ virtual-data-center:
+ description: |
+ Virtual organization of cloud infrastructure elements in a data center context
+ ###### Related Nodes
+ - FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
+ required:
+ - vdc-id
+ - vdc-name
+ properties:
+ vdc-id:
+ type: string
+ description: Unique ID of the vdc
+ vdc-name:
+ type: string
+ description: Name of the virtual data center
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ virtual-data-centers:
+ description: |
+ Virtual organization of cloud infrastructure elements in a data center context
+ properties:
+ virtual-data-center:
+ type: array
+ items:
+ $ref: "#/getDefinitions/virtual-data-center"
+ vlan:
+ description: |
+ Definition of vlan
+ ###### Related Nodes
+ - TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
+ - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
+ - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
+ - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
+ - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
+ - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK
+ required:
+ - vlan-interface
+ - in-maint
+ - is-ip-unnumbered
+ properties:
+ vlan-interface:
+ type: string
+ description: String that identifies the interface
+ vlan-id-inner:
+ type: integer
+ format: int64
+ description: Inner VLAN tag
+ vlan-id-outer:
+ type: integer
+ format: int64
+ description: Outer VLAN tag
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ speed-value:
+ type: string
+ description: Captures the numeric part of the speed
+ speed-units:
+ type: string
+ description: Captures the units corresponding to the speed
+ vlan-description:
+ type: string
+ description: Used to describe (the service associated with) the vlan
+ backdoor-connection:
+ type: string
+ description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
+ vpn-key:
+ type: string
+ description: This indicates the customers VPN ID associated with this vlan
+ orchestration-status:
+ type: string
+ description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.
+ in-maint:
+ type: boolean
+ prov-status:
+ type: string
+ description: Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV].
+ is-ip-unnumbered:
+ type: boolean
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ l3-interface-ipv4-address-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
+ l3-interface-ipv6-address-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
+ vlans:
+ properties:
+ vlan:
+ type: array
+ items:
+ $ref: "#/getDefinitions/vlan"
+ vnf:
+ description: |
+ Abstract vnf class
+ required:
+ - vnf-id
+ properties:
+ vnf-id:
+ type: string
+ description: Unique id of VNF. This is unique across the graph.
+ vnf-image:
+ description: |
+ Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge.
+ ###### Related Nodes
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
+ - VNF-IMAGE cannot be deleted if linked to GENERIC-VNF
+ required:
+ - vnf-image-uuid
+ - application
+ - application-vendor
+ properties:
+ vnf-image-uuid:
+ type: string
+ description: Unique ID of this asset
+ application:
+ type: string
+ description: The application that the image instantiates.
+ application-vendor:
+ type: string
+ description: The vendor of the application.
+ application-version:
+ type: string
+ description: The version of the application.
+ selflink:
+ type: string
+ description: URL to endpoint where AAI can get more details
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ vnf-images:
+ description: |
+ Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge.
+ properties:
+ vnf-image:
+ type: array
+ items:
+ $ref: "#/getDefinitions/vnf-image"
+ vnfc:
+ description: |
+ ###### Related Nodes
+ - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
+ - TO instance-group( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
+ - TO vip-ipv4-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
+ - TO vip-ipv6-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
+ - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
+ - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
+ - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
+ - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
+ - VNFC is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
+ required:
+ - vnfc-name
+ - nfc-naming-code
+ - nfc-function
+ - in-maint
+ - is-closed-loop-disabled
+ properties:
+ vnfc-name:
+ type: string
+ description: Unique ID of vnfc.
+ nfc-naming-code:
+ type: string
+ description: Short code that is used in naming instances of the item being modeled
+ nfc-function:
+ type: string
+ description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
+ prov-status:
+ type: string
+ description: prov status of this vnfc
+ orchestration-status:
+ type: string
+ description: Orchestration status of this VNF, mastered by APP-C
+ ipaddress-v4-oam-vip:
+ type: string
+ description: Oam V4 vip address of this vnfc
+ in-maint:
+ type: boolean
+ is-closed-loop-disabled:
+ type: boolean
+ group-notation:
+ type: string
+ description: Group notation of VNFC
+ model-invariant-id:
+ type: string
+ description: the ASDC model id for this resource or service model.
+ model-version-id:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ l3-interface-ipv4-address-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
+ l3-interface-ipv6-address-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
+ vnfcs:
+ description: |
+ virtual network components associated with a vserver from application controller.
+ properties:
+ vnfc:
+ type: array
+ items:
+ $ref: "#/getDefinitions/vnfc"
+ volume:
+ description: |
+ Ephemeral Block storage volume.
+ ###### Related Nodes
+ - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume)
+ required:
+ - volume-id
+ - volume-selflink
+ properties:
+ volume-id:
+ type: string
+ description: Unique ID of block storage volume relative to the vserver.
+ volume-selflink:
+ type: string
+ description: URL to endpoint where AAI can get more details
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ volume-group:
+ description: |
+ Persistent block-level storage.
+ ###### Related Nodes
+ - TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
+ - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
+ - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
+ - FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
+ required:
+ - volume-group-id
+ - volume-group-name
+ - vnf-type
+ properties:
+ volume-group-id:
+ type: string
+ description: Unique ID of volume-group.
+ volume-group-name:
+ type: string
+ description: Name of the volume group.
+ heat-stack-id:
+ type: string
+ description: Heat stack id corresponding to this volume-group
+ vnf-type:
+ type: string
+ description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
+ orchestration-status:
+ type: string
+ description: Orchestration status of this volume-group
+ model-customization-id:
+ type: string
+ description: captures the id of all the configuration used to customize the resource for the service.
+ vf-module-model-customization-id:
+ type: string
+ description: helps relate the volume group to the vf-module whose components will require the volume group
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ volume-groups:
+ description: |
+ Collection of persistent block-level storage.
+ properties:
+ volume-group:
+ type: array
+ items:
+ $ref: "#/getDefinitions/volume-group"
+ volumes:
+ description: |
+ Collection of ephemeral Block storage volumes.
+ properties:
+ volume:
+ type: array
+ items:
+ $ref: "#/getDefinitions/volume"
+ vpls-pe:
+ description: |
+ VPLS Provider Edge routers.
+ ###### Related Nodes
+ - TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
+ - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
+ - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
+ - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
+ required:
+ - equipment-name
+ properties:
+ equipment-name:
+ type: string
+ prov-status:
+ type: string
+ description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
+ ipv4-oam-address:
+ type: string
+ description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
+ equipment-role:
+ type: string
+ description: Client should send valid enumerated value, e.g., VPLS-PE.
+ vlan-id-outer:
+ type: integer
+ format: int64
+ description: Temporary location for stag to get to VCE
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ p-interfaces:
+ type: array
+ items:
+ $ref: "#/getDefinitions/p-interface"
+ lag-interfaces:
+ type: array
+ items:
+ $ref: "#/getDefinitions/lag-interface"
+ vpls-pes:
+ description: |
+ Collection of VPLS Provider Edge routers
+ properties:
+ vpls-pe:
+ type: array
+ items:
+ $ref: "#/getDefinitions/vpls-pe"
+ vpn-binding:
+ description: |
+ VPN binding
+ ###### Related Nodes
+ - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY)
+ - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
+ - FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
+ - FROM route-target( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
+ - VPN-BINDING cannot be deleted if linked to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK
+ - VPN-BINDING is DELETED when these are DELETED ROUTE-TARGET
+ required:
+ - vpn-id
+ - vpn-name
+ properties:
+ vpn-id:
+ type: string
+ description: VPN ID, globally unique within A&AI
+ vpn-name:
+ type: string
+ description: VPN Name
+ vpn-platform:
+ type: string
+ description: the platform associated with the VPN example AVPN, Mobility
+ vpn-type:
+ type: string
+ description: Type of the vpn, should be taken from enumerated/valid values
+ vpn-region:
+ type: string
+ description: region of customer vpn
+ customer-vpn-id:
+ type: string
+ description: id for this customer vpn
+ route-distinguisher:
+ type: string
+ description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ route-targets:
+ type: array
+ items:
+ $ref: "#/getDefinitions/route-target"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ description: l3-networks relate to vpn-bindings
+ vpn-bindings:
+ properties:
+ vpn-binding:
+ type: array
+ items:
+ $ref: "#/getDefinitions/vpn-binding"
+ vserver:
+ description: |
+ Virtual Servers, aka virtual machine or VM.
+ ###### Related Nodes
+ - TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
+ - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
+ - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
+ - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
+ - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
+ - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY)
+ - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
+ - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY)
+ - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
+ - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
+ - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
+ - VSERVER is DELETED when these are DELETED L-INTERFACE
+ - VSERVER deletion means associated objects of these types are also DELETED:VOLUME
+ required:
+ - vserver-id
+ - vserver-name
+ - vserver-selflink
+ - in-maint
+ - is-closed-loop-disabled
+ properties:
+ vserver-id:
+ type: string
+ description: Unique identifier for this vserver relative to its tenant
+ vserver-name:
+ type: string
+ description: Name of vserver
+ vserver-name2:
+ type: string
+ description: Alternative name of vserver
+ prov-status:
+ type: string
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ vserver-selflink:
+ type: string
+ description: URL to endpoint where AAI can get more details
+ in-maint:
+ type: boolean
+ is-closed-loop-disabled:
+ type: boolean
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ volumes:
+ type: array
+ items:
+ $ref: "#/getDefinitions/volume"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ l-interfaces:
+ type: array
+ items:
+ $ref: "#/getDefinitions/l-interface"
+ vservers:
+ description: |
+ Collection of virtual Servers, aka virtual machines or VMs.
+ properties:
+ vserver:
+ type: array
+ items:
+ $ref: "#/getDefinitions/vserver"
+ zone:
+ description: |
+ A zone is a grouping of assets in a location homing to the same connections into the CBB
+ ###### Related Nodes
+ - TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
+ - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
+ - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
+ - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
+ - FROM service-instance( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
+ required:
+ - zone-id
+ - zone-name
+ - design-type
+ - zone-context
+ properties:
+ zone-id:
+ type: string
+ description: Code assigned by AIC to the zone
+ zone-name:
+ type: string
+ description: English name associated with the zone
+ design-type:
+ type: string
+ description: Design of zone [Medium/Largeā€¦]
+ zone-context:
+ type: string
+ description: Context of zone [production/test]
+ status:
+ type: string
+ description: Status of a zone.
+ resource-version:
+ type: string
+ description: Concurrency value
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/getDefinitions/relationship"
+ zones:
+ description: |
+ Collection of zones
+ properties:
+ zone:
+ type: array
+ items:
+ $ref: "#/getDefinitions/zone"